Skip to main content

internal

Home > @backstage/backend-openapi-utils > internal

Interfaces

InterfaceDescription
CookieObject
DocRequestMatcherSuperset of the express router path matcher that enforces typed request and response bodies.
HeaderObject
PathObject
QueryObject

Type Aliases

Type AliasDescription
ComponentRef
ComponentTypes
ConvertAll
CookieSchema
DiscriminateUnion
DocOperation
DocParameter
DocParameters
DocPathAll paths for a given doc,
DocPathMethod
DocPathTemplate
DocPathTemplateMethod
DocRequestHandlerTyped express request handler.
DocRequestHandlerParamsTyped express error handler / request handler union type.
Filter
FromNumberStringToNumberHelper to convert from string to number, used to index arrays and pull out just the indices in the array.
FullMap
HeaderSchema
ImmutableFrom https://github.com/microsoft/TypeScript/issues/13923#issuecomment-653675557, allows us to convert from as const to the various OpenAPI types documented in openapi3-ts.
ImmutableContentObject
ImmutableCookieObject
ImmutableHeaderObject
ImmutableObject
ImmutableOpenAPIObject
ImmutableParameterObject
ImmutablePathObject
ImmutableQueryObject
ImmutableReferenceObject
ImmutableRequestBodyObject
ImmutableResponseObject
ImmutableSchemaObject
LastOf
MapDiscriminatedUnion
MapToSchema
MethodAwareDocPath
ObjectWithContentSchema
OptionalMap
ParameterSchema
ParametersSchema
PathDoc
PathSchema
PathTemplateValidate a string against OpenAPI path template, https://spec.openapis.org/oas/v3.1.0#path-templating-matching.
PickOptionalKeys
PickRequiredKeys
Push
QuerySchema
RequestBody
RequestBodySchema
RequestBodyToJsonSchemaTransform the OpenAPI request body schema to a typesafe JSON schema.
RequiredDocBasic OpenAPI spec with paths and components properties enforced.
RequiredMap
Response
ResponseBodyToJsonSchemaTransform the OpenAPI request body schema to a typesafe JSON schema.
ResponseSchemas
SchemaRef
TemplateToDocPathExtract path as specified in OpenAPI Doc based on request path
ToTypeSafe
TuplifyUnion
UnionToIntersection

From https://stackoverflow.com/questions/71393738/typescript-intersection-not-union-type-from-json-schema

StackOverflow says not to do this, but union types aren't possible any other way.

UnknownIfNever
ValueOfGet value types of T.