Skip to content

Commit ed72b17

Browse files
oriolriusclaude
andcommitted
docs: add OpenAPI spec URLs to REST API description
Add a section documenting the OpenAPI specification endpoints (/api/v1/openapi.json and /api/v1/openapi.yaml) in the API description. This helps third-party tools discover and integrate with the API. Bump version to 1.3.0 in all package.json files. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent e61a020 commit ed72b17

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

backend/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@pki-manager/backend",
3-
"version": "1.1.2",
3+
"version": "1.3.0",
44
"private": true,
55
"type": "module",
66
"description": "PKI Manager Backend - Fastify + tRPC API server",

backend/src/rest/openapi.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ export const swaggerOptions: FastifyDynamicSwaggerOptions = {
1515
This API provides RESTful endpoints for managing Certificate Authorities (CAs),
1616
certificates, Certificate Revocation Lists (CRLs), and related operations.
1717
18+
## OpenAPI Specification
19+
20+
The OpenAPI 3.1 specification is available at:
21+
- **JSON**: \`/api/v1/openapi.json\`
22+
- **YAML**: \`/api/v1/openapi.yaml\`
23+
24+
Use these URLs to integrate with third-party tools, code generators, or API clients.
25+
1826
## Features
1927
- Certificate Authority management (create, revoke, delete)
2028
- Certificate lifecycle management (issue, renew, revoke, download)

frontend/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "frontend",
33
"private": true,
4-
"version": "1.2.1",
4+
"version": "1.3.0",
55
"type": "module",
66
"scripts": {
77
"dev": "vite",

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "pki-manager",
3-
"version": "1.2.1",
3+
"version": "1.3.0",
44
"private": true,
55
"description": "PKI Manager - Web-based Public Key Infrastructure management application",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)