@backstage/backend-openapi-utils 0.0.4 → 0.0.5

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @backstage/backend-openapi-utils
 
+## 0.0.5
+
+### Patch Changes
+
+- 7c83975531: Adds new public utility types for common OpenAPI values, like request and response shapes and parameters available on an endpoint.
+
+  **deprecated** `internal` namespace
+  The internal namespace will continue to be exported but now uses OpenAPI format for path parameters. You should use the new utility types.
+
+- Updated dependencies
+  - @backstage/errors@1.2.3
+
+## 0.0.5-next.0
+
+### Patch Changes
+
+- 7c83975531: Adds new public utility types for common OpenAPI values, like request and response shapes and parameters available on an endpoint.
+
+  **deprecated** `internal` namespace
+  The internal namespace will continue to be exported but now uses OpenAPI format for path parameters. You should use the new utility types.
+
+- Updated dependencies
+  - @backstage/errors@1.2.3-next.0
+
 ## 0.0.4
 
 ### Patch Changes

package/README.md

@@ -61,6 +61,12 @@ export function createRouter() {
 }
 ```
 
+## FAQs
+
+### Why am I getting `unknown` as the type for a response?
+
+This can happen when you have a `charset` defined in your `response.content` section. Something like `response.content[    'application/json; charset=utf-8:']` will cause this issue.
+
 ## INTERNAL
 
 ### Limitations

package/dist/index.d.ts

@@ -114,6 +114,12 @@ type PathDoc = Pick<ImmutableOpenAPIObject, 'paths'>;
  * @public
  */
 type ValueOf<T> = T[keyof T];
+/**
+ * All paths for a given doc,
+ * @example `/pet/{petId}` | `/pet`
+ * @public
+ */
+type DocPath<Doc extends PathDoc> = Extract<keyof Doc['paths'], string>;
 /**
  * Validate a string against OpenAPI path template, {@link https://spec.openapis.org/oas/v3.1.0#path-templating-matching}.
  *
@@ -142,27 +148,31 @@ type PathTemplate<Path extends string> = Path extends `${infer Prefix}{${infer P
  *
  * @public
  */
-type DocPath<Doc extends PathDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>> = ValueOf<{
-    [Template in Extract<keyof Doc['paths'], string>]: Path extends PathTemplate<Template> ? Template : never;
+type TemplateToDocPath<Doc extends PathDoc, Path extends DocPathTemplate<Doc>> = ValueOf<{
+    [Template in DocPath<Doc>]: Path extends PathTemplate<Template> ? Template : never;
 }>;
 /**
  * @public
  */
-type DocPathTemplate<Doc extends PathDoc> = PathTemplate<Extract<keyof Doc['paths'], string>>;
+type DocPathTemplate<Doc extends PathDoc> = PathTemplate<DocPath<Doc>>;
 /**
  * @public
  */
-type DocPathMethod<Doc extends Pick<RequiredDoc, 'paths'>, Path extends DocPathTemplate<Doc>> = keyof Doc['paths'][DocPath<Doc, Path>];
+type DocPathMethod<Doc extends Pick<RequiredDoc, 'paths'>, Path extends DocPath<Doc>> = keyof Doc['paths'][Path];
 /**
  * @public
  */
-type MethodAwareDocPath<Doc extends PathDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends keyof Doc['paths'][Path]> = ValueOf<{
-    [Template in Extract<keyof Doc['paths'], string>]: Path extends PathTemplate<Template> ? Method extends DocPathMethod<Doc, Path> ? PathTemplate<Template> : never : never;
+type DocPathTemplateMethod<Doc extends Pick<RequiredDoc, 'paths'>, Path extends DocPathTemplate<Doc>> = keyof Doc['paths'][TemplateToDocPath<Doc, Path>];
+/**
+ * @public
+ */
+type MethodAwareDocPath<Doc extends PathDoc, Path extends DocPathTemplate<Doc>, Method extends DocPathTemplateMethod<Doc, Path>> = ValueOf<{
+    [Template in DocPath<Doc>]: Path extends PathTemplate<Template> ? Method extends DocPathTemplateMethod<Doc, Path> ? PathTemplate<Template> : never : never;
 }>;
 /**
  * @public
  */
-type DocOperation<Doc extends RequiredDoc, Path extends keyof Doc['paths'], Method extends keyof Doc['paths'][Path]> = Doc['paths'][Path][Method];
+type DocOperation<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends keyof Doc['paths'][Path]> = Doc['paths'][Path][Method];
 /**
  * @public
  */
@@ -278,7 +288,7 @@ type Filter<T, U> = T extends U ? T : never;
 /**
  * @public
  */
-type DocParameter<Doc extends RequiredDoc, Path extends Extract<keyof Doc['paths'], string>, Method extends keyof Doc['paths'][Path], Parameter extends keyof Doc['paths'][Path][Method]['parameters']> = DocOperation<Doc, Path, Method>['parameters'][Parameter] extends ImmutableReferenceObject ? 'parameters' extends ComponentTypes<Doc> ? ComponentRef<Doc, 'parameters', DocOperation<Doc, Path, Method>['parameters'][Parameter]> : never : DocOperation<Doc, Path, Method>['parameters'][Parameter];
+type DocParameter<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>, Parameter extends keyof DocOperation<Doc, Path, Method>['parameters']> = DocOperation<Doc, Path, Method>['parameters'][Parameter] extends ImmutableReferenceObject ? 'parameters' extends ComponentTypes<Doc> ? ComponentRef<Doc, 'parameters', DocOperation<Doc, Path, Method>['parameters'][Parameter]> : never : DocOperation<Doc, Path, Method>['parameters'][Parameter];
 /**
  * Helper to convert from string to number, used to index arrays and pull out just the indices in the array.
  * @public
@@ -307,19 +317,19 @@ type ParametersSchema<Doc extends RequiredDoc, Path extends Extract<keyof Doc['p
 /**
  * @public
  */
-type HeaderSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, DocPath<Doc, Path>, Method, ImmutableHeaderObject>;
+type HeaderSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, Path, Method, ImmutableHeaderObject>;
 /**
  * @public
  */
-type CookieSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, DocPath<Doc, Path>, Method, ImmutableCookieObject>;
+type CookieSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, Path, Method, ImmutableCookieObject>;
 /**
  * @public
  */
-type PathSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, DocPath<Doc, Path>, Method, ImmutablePathObject>;
+type PathSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, Path, Method, ImmutablePathObject>;
 /**
  * @public
  */
-type QuerySchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, DocPath<Doc, Path>, Method, ImmutableQueryObject>;
+type QuerySchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ParametersSchema<Doc, Path, Method, ImmutableQueryObject>;
 
 /**
  * Pulled from https://github.com/varanauskas/oatx.
@@ -332,12 +342,12 @@ type RequestBody<Doc extends RequiredDoc, Path extends Extract<keyof Doc['paths'
 /**
  * @public
  */
-type RequestBodySchema<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends DocPathMethod<Doc, Path>> = RequestBody<Doc, DocPath<Doc, Path>, Method> extends ImmutableRequestBodyObject ? ObjectWithContentSchema<Doc, RequestBody<Doc, DocPath<Doc, Path>, Method>> : never;
+type RequestBodySchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = RequestBody<Doc, Path, Method> extends ImmutableRequestBodyObject ? ObjectWithContentSchema<Doc, RequestBody<Doc, Path, Method>> : never;
 /**
  * Transform the OpenAPI request body schema to a typesafe JSON schema.
  * @public
  */
-type RequestBodyToJsonSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = ToTypeSafe<RequestBodySchema<Doc, Path, Method>>;
+type RequestBodyToJsonSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ToTypeSafe<RequestBodySchema<Doc, Path, Method>>;
 
 /**
  * Pulled from https://github.com/varanauskas/oatx.
@@ -346,47 +356,49 @@ type RequestBodyToJsonSchema<Doc extends RequiredDoc, Path extends PathTemplate<
 /**
  * @public
  */
-type Response<Doc extends RequiredDoc, Path extends keyof Doc['paths'], Method extends keyof Doc['paths'][Path], StatusCode extends keyof DocOperation<Doc, Path, Method>['responses']> = DocOperation<Doc, Path, Method>['responses'][StatusCode] extends ImmutableReferenceObject ? 'responses' extends ComponentTypes<Doc> ? ComponentRef<Doc, 'responses', DocOperation<Doc, Path, Method>['responses'][StatusCode]> : never : DocOperation<Doc, Path, Method>['responses'][StatusCode];
+type Response$1<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>, StatusCode extends keyof DocOperation<Doc, Path, Method>['responses']> = DocOperation<Doc, Path, Method>['responses'][StatusCode] extends ImmutableReferenceObject ? 'responses' extends ComponentTypes<Doc> ? ComponentRef<Doc, 'responses', DocOperation<Doc, Path, Method>['responses'][StatusCode]> : never : DocOperation<Doc, Path, Method>['responses'][StatusCode];
 /**
  * @public
  */
-type ResponseSchemas<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends DocPathMethod<Doc, Path>> = {
-    [StatusCode in keyof DocOperation<Doc, Path, Method>['responses']]: Response<Doc, Path, Method, StatusCode> extends ImmutableResponseObject ? ObjectWithContentSchema<Doc, Response<Doc, Path, Method, StatusCode>> : never;
+type ResponseSchemas<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = {
+    [StatusCode in keyof DocOperation<Doc, Path, Method>['responses']]: Response$1<Doc, Path, Method, StatusCode> extends ImmutableResponseObject ? ObjectWithContentSchema<Doc, Response$1<Doc, Path, Method, StatusCode>> : never;
 };
 /**
  * Transform the OpenAPI request body schema to a typesafe JSON schema.
  * @public
  */
-type ResponseBodyToJsonSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = ToTypeSafe<ValueOf<ResponseSchemas<Doc, Path, Method>>>;
+type ResponseBodyToJsonSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ToTypeSafe<ValueOf<ResponseSchemas<Doc, Path, Method>>>;
 
 /**
  * Typed express request handler.
  * @public
  */
-type DocRequestHandler<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends keyof Doc['paths'][Path]> = core.RequestHandler<PathSchema<Doc, Path, Method>, ResponseBodyToJsonSchema<Doc, Path, Method>, RequestBodyToJsonSchema<Doc, Path, Method>, QuerySchema<Doc, Path, Method>, Record<string, string>>;
+type DocRequestHandler<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = core.RequestHandler<PathSchema<Doc, Path, Method>, ResponseBodyToJsonSchema<Doc, Path, Method>, RequestBodyToJsonSchema<Doc, Path, Method>, QuerySchema<Doc, Path, Method>, Record<string, string>>;
 /**
  * Typed express error handler / request handler union type.
  * @public
  */
-type DocRequestHandlerParams<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends keyof Doc['paths'][Path]> = core.RequestHandlerParams<PathSchema<Doc, Path, Method>, ResponseBodyToJsonSchema<Doc, Path, Method>, RequestBodyToJsonSchema<Doc, Path, Method>, QuerySchema<Doc, Path, Method>, Record<string, string>>;
+type DocRequestHandlerParams<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = core.RequestHandlerParams<PathSchema<Doc, Path, Method>, ResponseBodyToJsonSchema<Doc, Path, Method>, RequestBodyToJsonSchema<Doc, Path, Method>, QuerySchema<Doc, Path, Method>, Record<string, string>>;
 /**
  * Superset of the express router path matcher that enforces typed request and response bodies.
  * @public
  */
 interface DocRequestMatcher<Doc extends RequiredDoc, T, Method extends 'all' | 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head'> {
-    <Path extends MethodAwareDocPath<Doc, DocPathTemplate<Doc>, Method>>(path: Path, ...handlers: Array<DocRequestHandler<Doc, Path, Method>>): T;
-    <Path extends MethodAwareDocPath<Doc, DocPathTemplate<Doc>, Method>>(path: Path, ...handlers: Array<DocRequestHandlerParams<Doc, Path, Method>>): T;
+    <Path extends MethodAwareDocPath<Doc, PathTemplate<Extract<keyof Doc['paths'], string>>, Method>>(path: Path, ...handlers: Array<DocRequestHandler<Doc, TemplateToDocPath<Doc, Path>, Method>>): T;
+    <Path extends MethodAwareDocPath<Doc, PathTemplate<Extract<keyof Doc['paths'], string>>, Method>>(path: Path, ...handlers: Array<DocRequestHandlerParams<Doc, TemplateToDocPath<Doc, Path>, Method>>): T;
 }
 
 type index_d_RequiredDoc = RequiredDoc;
 type index_d_PathDoc = PathDoc;
 type index_d_ValueOf<T> = ValueOf<T>;
+type index_d_DocPath<Doc extends PathDoc> = DocPath<Doc>;
 type index_d_PathTemplate<Path extends string> = PathTemplate<Path>;
-type index_d_DocPath<Doc extends PathDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>> = DocPath<Doc, Path>;
+type index_d_TemplateToDocPath<Doc extends PathDoc, Path extends DocPathTemplate<Doc>> = TemplateToDocPath<Doc, Path>;
 type index_d_DocPathTemplate<Doc extends PathDoc> = DocPathTemplate<Doc>;
-type index_d_DocPathMethod<Doc extends Pick<RequiredDoc, 'paths'>, Path extends DocPathTemplate<Doc>> = DocPathMethod<Doc, Path>;
-type index_d_MethodAwareDocPath<Doc extends PathDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends keyof Doc['paths'][Path]> = MethodAwareDocPath<Doc, Path, Method>;
-type index_d_DocOperation<Doc extends RequiredDoc, Path extends keyof Doc['paths'], Method extends keyof Doc['paths'][Path]> = DocOperation<Doc, Path, Method>;
+type index_d_DocPathMethod<Doc extends Pick<RequiredDoc, 'paths'>, Path extends DocPath<Doc>> = DocPathMethod<Doc, Path>;
+type index_d_DocPathTemplateMethod<Doc extends Pick<RequiredDoc, 'paths'>, Path extends DocPathTemplate<Doc>> = DocPathTemplateMethod<Doc, Path>;
+type index_d_MethodAwareDocPath<Doc extends PathDoc, Path extends DocPathTemplate<Doc>, Method extends DocPathTemplateMethod<Doc, Path>> = MethodAwareDocPath<Doc, Path, Method>;
+type index_d_DocOperation<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends keyof Doc['paths'][Path]> = DocOperation<Doc, Path, Method>;
 type index_d_ComponentTypes<Doc extends RequiredDoc> = ComponentTypes<Doc>;
 type index_d_ComponentRef<Doc extends RequiredDoc, Type extends ComponentTypes<Doc>, Ref extends ImmutableReferenceObject> = ComponentRef<Doc, Type, Ref>;
 type index_d_SchemaRef<Doc extends RequiredDoc, Schema> = SchemaRef<Doc, Schema>;
@@ -418,8 +430,8 @@ type index_d_FullMap<T extends {
     [key: string]: any;
 }> = FullMap<T>;
 type index_d_Filter<T, U> = Filter<T, U>;
-type index_d_DocRequestHandler<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends keyof Doc['paths'][Path]> = DocRequestHandler<Doc, Path, Method>;
-type index_d_DocRequestHandlerParams<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends keyof Doc['paths'][Path]> = DocRequestHandlerParams<Doc, Path, Method>;
+type index_d_DocRequestHandler<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = DocRequestHandler<Doc, Path, Method>;
+type index_d_DocRequestHandlerParams<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = DocRequestHandlerParams<Doc, Path, Method>;
 type index_d_DocRequestMatcher<Doc extends RequiredDoc, T, Method extends 'all' | 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head'> = DocRequestMatcher<Doc, T, Method>;
 type index_d_Immutable<T> = Immutable<T>;
 type index_d_ImmutableObject<T> = ImmutableObject<T>;
@@ -438,31 +450,32 @@ type index_d_ImmutableQueryObject = ImmutableQueryObject;
 type index_d_PathObject = PathObject;
 type index_d_ImmutablePathObject = ImmutablePathObject;
 type index_d_ImmutableSchemaObject = ImmutableSchemaObject;
-type index_d_DocParameter<Doc extends RequiredDoc, Path extends Extract<keyof Doc['paths'], string>, Method extends keyof Doc['paths'][Path], Parameter extends keyof Doc['paths'][Path][Method]['parameters']> = DocParameter<Doc, Path, Method, Parameter>;
+type index_d_DocParameter<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>, Parameter extends keyof DocOperation<Doc, Path, Method>['parameters']> = DocParameter<Doc, Path, Method, Parameter>;
 type index_d_FromNumberStringToNumber<NumberString extends string | number | symbol> = FromNumberStringToNumber<NumberString>;
 type index_d_DocParameters<Doc extends RequiredDoc, Path extends Extract<keyof Doc['paths'], string>, Method extends keyof Doc['paths'][Path]> = DocParameters<Doc, Path, Method>;
 type index_d_ParameterSchema<Doc extends RequiredDoc, Schema extends ImmutableParameterObject['schema']> = ParameterSchema<Doc, Schema>;
 type index_d_MapToSchema<Doc extends RequiredDoc, T extends Record<string, ImmutableParameterObject>> = MapToSchema<Doc, T>;
 type index_d_ParametersSchema<Doc extends RequiredDoc, Path extends Extract<keyof Doc['paths'], string>, Method extends keyof Doc['paths'][Path], FilterType extends ImmutableParameterObject> = ParametersSchema<Doc, Path, Method, FilterType>;
-type index_d_HeaderSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = HeaderSchema<Doc, Path, Method>;
-type index_d_CookieSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = CookieSchema<Doc, Path, Method>;
-type index_d_PathSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = PathSchema<Doc, Path, Method>;
-type index_d_QuerySchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = QuerySchema<Doc, Path, Method>;
+type index_d_HeaderSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = HeaderSchema<Doc, Path, Method>;
+type index_d_CookieSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = CookieSchema<Doc, Path, Method>;
+type index_d_PathSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = PathSchema<Doc, Path, Method>;
+type index_d_QuerySchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = QuerySchema<Doc, Path, Method>;
 type index_d_RequestBody<Doc extends RequiredDoc, Path extends Extract<keyof Doc['paths'], string>, Method extends keyof Doc['paths'][Path]> = RequestBody<Doc, Path, Method>;
-type index_d_RequestBodySchema<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends DocPathMethod<Doc, Path>> = RequestBodySchema<Doc, Path, Method>;
-type index_d_RequestBodyToJsonSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = RequestBodyToJsonSchema<Doc, Path, Method>;
-type index_d_Response<Doc extends RequiredDoc, Path extends keyof Doc['paths'], Method extends keyof Doc['paths'][Path], StatusCode extends keyof DocOperation<Doc, Path, Method>['responses']> = Response<Doc, Path, Method, StatusCode>;
-type index_d_ResponseSchemas<Doc extends RequiredDoc, Path extends DocPathTemplate<Doc>, Method extends DocPathMethod<Doc, Path>> = ResponseSchemas<Doc, Path, Method>;
-type index_d_ResponseBodyToJsonSchema<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathMethod<Doc, Path>> = ResponseBodyToJsonSchema<Doc, Path, Method>;
+type index_d_RequestBodySchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = RequestBodySchema<Doc, Path, Method>;
+type index_d_RequestBodyToJsonSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = RequestBodyToJsonSchema<Doc, Path, Method>;
+type index_d_ResponseSchemas<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ResponseSchemas<Doc, Path, Method>;
+type index_d_ResponseBodyToJsonSchema<Doc extends RequiredDoc, Path extends DocPath<Doc>, Method extends DocPathMethod<Doc, Path>> = ResponseBodyToJsonSchema<Doc, Path, Method>;
 declare namespace index_d {
   export {
     index_d_RequiredDoc as RequiredDoc,
     index_d_PathDoc as PathDoc,
     index_d_ValueOf as ValueOf,
-    index_d_PathTemplate as PathTemplate,
     index_d_DocPath as DocPath,
+    index_d_PathTemplate as PathTemplate,
+    index_d_TemplateToDocPath as TemplateToDocPath,
     index_d_DocPathTemplate as DocPathTemplate,
     index_d_DocPathMethod as DocPathMethod,
+    index_d_DocPathTemplateMethod as DocPathTemplateMethod,
     index_d_MethodAwareDocPath as MethodAwareDocPath,
     index_d_DocOperation as DocOperation,
     index_d_ComponentTypes as ComponentTypes,
@@ -517,12 +530,37 @@ declare namespace index_d {
     index_d_RequestBody as RequestBody,
     index_d_RequestBodySchema as RequestBodySchema,
     index_d_RequestBodyToJsonSchema as RequestBodyToJsonSchema,
-    index_d_Response as Response,
+    Response$1 as Response,
     index_d_ResponseSchemas as ResponseSchemas,
     index_d_ResponseBodyToJsonSchema as ResponseBodyToJsonSchema,
   };
 }
 
+/**
+ * @public
+ */
+type Response<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathTemplateMethod<Doc, Path>> = ResponseBodyToJsonSchema<Doc, TemplateToDocPath<Doc, Path>, Method>;
+/**
+ * @public
+ */
+type Request<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathTemplateMethod<Doc, Path>> = RequestBodyToJsonSchema<Doc, TemplateToDocPath<Doc, Path>, Method>;
+/**
+ * @public
+ */
+type HeaderParameters<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathTemplateMethod<Doc, Path>> = HeaderSchema<Doc, TemplateToDocPath<Doc, Path>, Method>;
+/**
+ * @public
+ */
+type CookieParameters<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathTemplateMethod<Doc, Path>> = CookieSchema<Doc, TemplateToDocPath<Doc, Path>, Method>;
+/**
+ * @public
+ */
+type PathParameters<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathTemplateMethod<Doc, Path>> = PathSchema<Doc, TemplateToDocPath<Doc, Path>, Method>;
+/**
+ * @public
+ */
+type QueryParameters<Doc extends RequiredDoc, Path extends PathTemplate<Extract<keyof Doc['paths'], string>>, Method extends DocPathTemplateMethod<Doc, Path>> = QuerySchema<Doc, TemplateToDocPath<Doc, Path>, Method>;
+
 /**
  * Typed Express router based on an OpenAPI 3.1 spec.
  * @public
@@ -550,4 +588,4 @@ declare function createValidatedOpenApiRouter<T extends RequiredDoc>(spec: T, op
     middleware?: RequestHandler[];
 }): ApiRouter<T>;
 
-export { ApiRouter, createValidatedOpenApiRouter, index_d as internal };
+export { ApiRouter, CookieParameters, HeaderParameters, PathParameters, QueryParameters, Request, Response, createValidatedOpenApiRouter, index_d as internal };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-openapi-utils",
   "description": "OpenAPI typescript support.",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -30,14 +30,14 @@
     "postpack": "backstage-cli package postpack"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.13",
+    "@backstage/cli": "^0.23.0",
     "supertest": "^6.1.3"
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@backstage/errors": "^1.2.2",
+    "@backstage/errors": "^1.2.3",
     "@types/express": "^4.17.6",
     "@types/express-serve-static-core": "^4.17.5",
     "express": "^4.17.1",