PDF Service

Base URL: /, Version: 1.1.0

A PDF Serice API that renders HTML templates to PDF

Default request content-types: application/json
Schemes: http

Summary

Path Operation Description
/ GET
POST
/healthcheck GET
/metrics GET
/status GET

Security

basicAuth

Type: basic
Description:

Basic authentication

Paths

GET /

Returns this auto generated documentation

text/html

200 OK

Service is up an running

POST /

Creates a new PDF

Uses default content-types: application/json

HTML to convert to PDF

pdf

application/pdf

200 OK

OK PDF response

400 Bad Request

BAD_REQUEST invalid arguments

401 Unauthorized

UNAUTHORIZED on invalid basic auth

GET /healthcheck

Returns health status of the service

text/html

200 OK

Returns OK and uptime in seconds if service is running

GET /metrics

Returns a set of default prometheus metrics such as http_request_duration_seconds_bucket

text/html

200 OK

Service is up an running

401 Unauthorized

UNAUTHORIZED on invalid basic auth

basicAuth

GET /status

Returns status page with CPU, Mem, AVG Load, Response Time and Requests per Seconds

text/html

200 OK

Service is up an running

401 Unauthorized

UNAUTHORIZED on invalid basic auth

basicAuth

Schema definitions

pdf: object

html: string (byte)

Service is up an running

footer: string (byte)
options: string