Reusable Schemas

Before continuing, please learn more about Reusing Descriptions by OpenAPI.

To start reusing your schemas, all you need to do is call the .openapi("schema name here") after any schema you have defined. This includes parameters, requestBody, responses even Enum.

Note

This is only available when using chanfana types or zod types

export class PutMetadata extends OpenAPIRoute {
  schema = {
    operationId: 'post-bucket-put-object-metadata',
    tags: ['Buckets'],
    summary: 'Update object metadata',
    parameters: {
      bucket: Path(String),
      key: Path(z.string().describe('base64 encoded file key')),
    },
    requestBody: z.object({
      customMetadata: z.record(z.string(), z.any())
    }).openapi("Object metadata")
  }

  // ...
}

Then when running the server, it would get rendered like this:

The OpenAPI spec will also reflect this, by moving the schemas out of the endpoint and into the components:

{
  "components": {
    "schemas": {
      "Object metadata": {
        "type": "object",
        "properties": {
          "customMetadata": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "customMetadata"
        ]
      }
    }
  }
}

Inside the endpoint schema, the reusable parameter is referenced by the name:

{
  "paths": {
    "post": {
      "operationId": "post-bucket-put-object-metadata",
      "tags": [
        "Buckets"
      ],
      "summary": "Update object metadata",
      "parameters": [],
      "requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Object metadata"
            }
          }
        }
      },
      "responses": {}
    }
  }
}
}