nooschain / api/swagger-config / buildOpenApiDocument
Function: buildOpenApiDocument()
buildOpenApiDocument():
object
Defined in: api/swagger-config.ts:321
Builds a standalone OpenAPI document from the same schemas used by route declarations. The application server normally serves a dynamic document from Fastify itself; this static document is for a separate docs-only port.
Returns
object
components
components:
object
components.schemas
schemas:
Record<string,OpenApiSchema> =openApiComponentSchemas
components.securitySchemes
securitySchemes:
object
components.securitySchemes.bearerAuth
bearerAuth:
object
components.securitySchemes.bearerAuth.description
description:
string="Bearer token API auth, including NOOS_OPERATOR_TOKEN for operator endpoints."
components.securitySchemes.bearerAuth.scheme
scheme:
"bearer"
components.securitySchemes.bearerAuth.type
type:
"http"
components.securitySchemes.devPublicKeyHeader
devPublicKeyHeader:
object
components.securitySchemes.devPublicKeyHeader.description
description:
string="Development-only public-key actor shortcut. Disabled in production."
components.securitySchemes.devPublicKeyHeader.in
in:
"header"
components.securitySchemes.devPublicKeyHeader.name
name:
string="x-noos-public-key"
components.securitySchemes.devPublicKeyHeader.type
type:
"apiKey"
components.securitySchemes.nodeSignedHeaders
nodeSignedHeaders:
object
components.securitySchemes.nodeSignedHeaders.description
description:
string="Node-to-node signed header auth using x-noos-node-id, x-noos-node-timestamp, and x-noos-node-signature."
components.securitySchemes.nodeSignedHeaders.in
in:
"header"
components.securitySchemes.nodeSignedHeaders.name
name:
string="x-noos-node-signature"
components.securitySchemes.nodeSignedHeaders.type
type:
"apiKey"
info
info:
object=openApiInfo
info.description
description:
string="Development OpenAPI documentation for NOOSChain HTTP APIs. Routes are grouped as Public/System, Blockchain/Domain API, Operator/Local Operations, Node-to-node/Internal, and Development helpers. Operator routes require NOOS_OPERATOR_TOKEN. Node-to-node routes require signed node headers."
info.title
title:
string="NOOSChain Operator and Node API"
info.version
version:
string="0.1.0"
openapi
openapi:
"3.0.3"
paths
paths:
Record<string,Record<string,unknown>>
tags
tags:
object[]