Skip to main content

Module openapi_review

Module openapi_review 

Source
Expand description

Transport-neutral, bounded OpenAPI document classification and cataloging.

This module deliberately owns no transport, authority, request planner, or executor. It reduces a bounded JSON document to deterministic protocol metadata. Prose, examples, defaults, raw security-scheme names, and server values are never retained.

Structs§

OpenApiCatalog
OpenApiCatalogSummary
OpenApiDocument
OpenApiDocumentLimits
Checked parser ceilings. Callers may narrow, but cannot widen, hard limits.
OpenApiOperation
Reduced operation metadata. Debug deliberately omits the raw path.
OpenApiOperationId
OpenApiParameterMetadata
OpenApiResponseMetadata
OpenApiResponseSummary
OpenApiSecurityMetadata
OpenApiServerMetadata

Enums§

OpenApiCandidateTag
OpenApiDocumentKind
OpenApiFormatClass
OpenApiHttpMethod
OpenApiMediaFamily
OpenApiParameterLocation
OpenApiParseOutcome
OpenApiResponseStatus
OpenApiReviewError
OpenApiSchemaPrimitiveKind
OpenApiSecuritySchemeKind
OpenApiSecuritySource
OpenApiServerKind
OpenApiVersion

Constants§

MAX_MEDIA_ENTRIES_PER_OPERATION
MAX_OPENAPI_ARRAY_LENGTH
MAX_OPENAPI_DOCUMENT_BYTES
MAX_OPENAPI_JSON_DEPTH
MAX_OPENAPI_JSON_NODES
MAX_OPENAPI_MEDIA_TYPES_PER_OPERATION
MAX_OPENAPI_OBJECT_MEMBERS
MAX_OPENAPI_OPERATIONS
MAX_OPENAPI_PARAMETERS_PER_OPERATION
MAX_OPENAPI_PATHS
MAX_OPENAPI_PATH_BYTES
MAX_OPENAPI_PATH_SEGMENTS
MAX_OPENAPI_RESPONSES_PER_OPERATION
MAX_OPENAPI_SECURITY_REQUIREMENTS
MAX_OPENAPI_SERVERS
MAX_OPENAPI_STRING_BYTES
MAX_OPENAPI_TOKEN_BYTES
OPENAPI_CATALOG_ALGORITHM

Functions§

parse_openapi_document
Classifies and reduces one repository- or host-retained document.