diff --git a/packages/backend-openapi-utils/api-report.md b/packages/backend-openapi-utils/api-report.md index 26215ad2a5..97ea0224d1 100644 --- a/packages/backend-openapi-utils/api-report.md +++ b/packages/backend-openapi-utils/api-report.md @@ -74,6 +74,13 @@ interface CookieObject extends ParameterObject { style?: 'form'; } +// @public (undocumented) +export type CookieParameters< + Doc extends RequiredDoc, + Path extends PathTemplate>, + Method extends DocPathTemplateMethod, +> = CookieSchema, Method>; + // @public (undocumented) type CookieSchema< Doc extends RequiredDoc, @@ -249,6 +256,13 @@ interface HeaderObject extends ParameterObject { style: 'simple'; } +// @public (undocumented) +export type HeaderParameters< + Doc extends RequiredDoc, + Path extends PathTemplate>, + Method extends DocPathTemplateMethod, +> = HeaderSchema, Method>; + // @public (undocumented) type HeaderSchema< Doc extends RequiredDoc, @@ -376,7 +390,7 @@ declare namespace internal { RequestBody, RequestBodySchema, RequestBodyToJsonSchema, - Response_2 as Response, + Response_3 as Response, ResponseSchemas, ResponseBodyToJsonSchema, }; @@ -476,6 +490,13 @@ interface PathObject extends ParameterObject { style?: 'simple' | 'label' | 'matrix'; } +// @public (undocumented) +export type PathParameters< + Doc extends RequiredDoc, + Path extends PathTemplate>, + Method extends DocPathTemplateMethod, +> = PathSchema, Method>; + // @public (undocumented) type PathSchema< Doc extends RequiredDoc, @@ -518,6 +539,13 @@ interface QueryObject extends ParameterObject { style?: 'form' | 'deepObject' | 'pipeDelimited' | 'spaceDelimited'; } +// @public (undocumented) +export type QueryParameters< + Doc extends RequiredDoc, + Path extends PathTemplate>, + Method extends DocPathTemplateMethod, +> = QuerySchema, Method>; + // @public (undocumented) type QuerySchema< Doc extends RequiredDoc, @@ -525,6 +553,14 @@ type QuerySchema< Method extends DocPathMethod, > = ParametersSchema; +// @public (undocumented) +type Request_2< + Doc extends RequiredDoc, + Path extends PathTemplate>, + Method extends DocPathTemplateMethod, +> = RequestBodyToJsonSchema, Method>; +export { Request_2 as Request }; + // @public (undocumented) type RequestBody< Doc extends RequiredDoc, @@ -574,6 +610,14 @@ type RequiredMap< // @public (undocumented) type Response_2< + Doc extends RequiredDoc, + Path extends PathTemplate>, + Method extends DocPathTemplateMethod, +> = ResponseBodyToJsonSchema, Method>; +export { Response_2 as Response }; + +// @public (undocumented) +type Response_3< Doc extends RequiredDoc, Path extends DocPath, Method extends DocPathMethod, @@ -609,13 +653,13 @@ type ResponseSchemas< Doc, Path, Method - >['responses']]: Response_2< + >['responses']]: Response_3< Doc, Path, Method, StatusCode > extends ImmutableResponseObject - ? ObjectWithContentSchema> + ? ObjectWithContentSchema> : never; }; diff --git a/packages/backend-openapi-utils/src/index.ts b/packages/backend-openapi-utils/src/index.ts index 3acdcbf6f0..23df7bb9c6 100644 --- a/packages/backend-openapi-utils/src/index.ts +++ b/packages/backend-openapi-utils/src/index.ts @@ -22,5 +22,6 @@ import * as internal from './types'; export { internal }; +export * from './utility'; export type { ApiRouter } from './router'; export { createValidatedOpenApiRouter } from './stub';