Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/barchart/aws-lambda-pdf-generator/llms.txt

Use this file to discover all available pages before exploring further.

The GET /service/version endpoint returns a JSON object containing metadata about the running service instance. The response includes the package name and description sourced from package.json, the current deployment environment derived from the NODE_ENV Lambda environment variable (set automatically by the Serverless Framework to stage or prod at deploy time), and the current semantic version of the service. No request body or query parameters are required.

Request

Method: GET
Path: /service/version
This endpoint requires no request body, query parameters, or authentication headers beyond whatever API Gateway authorization you have configured for your deployment.

Example Request

curl 'https://{api-identifier}.execute-api.us-east-1.amazonaws.com/prod/service/version'

Response

200 OKapplication/json
{
  "service": {
    "name": "@barchart/serverless-pdf-generator",
    "description": "Web service for conversion of HTML to PDF",
    "environment": "prod",
    "version": "3.0.1"
  }
}

Response Fields

service
object
required
Top-level container for all service metadata fields.
Call GET /service/version immediately after deploying to verify that the service is reachable and that the environment and version fields match what you intended to deploy. A successful 200 response with the correct values is a reliable smoke test before routing production traffic to a new deployment.

Build docs developers (and LLMs) love