feat(openapi): allow $global.components in defineRouteMeta

[OskarLebuda]

🔗 Linked issue

Fixes #2920

❓ Type of change

• 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Add components support for OpenAPI module.

Usage:

defineRouteMeta({
  openAPI: {
    tags: ["test"],
    description: "Test route description",
    parameters: [{ in: "query", name: "test", required: true }],
    responses: {
      200: {
        description: "default",
        content: {
          "application/json": { schema: { $ref: "#/components/schemas/Test" } },
        },
      },
    },
    $global: {
      components: {
        schemas: {
          Test: {
            type: "object",
            properties: {
              status: {
                type: "string",
                enum: ["OK", "ERROR"],
              },
            },
          },
        },
      },
    },
  },
});

Result:

{
  "openapi": "3.1.0",
  "paths": {
    "/api/meta/test": {
      "get": {
        "tags": [
          "test"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "test",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Test"
                }
              }
            }
          }
        },
        "description": "Test route description"
      }
    }
  },
  "components": {
    "schemas": {
      "Test": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "OK",
              "ERROR"
            ]
          }
        }
      }
    }
  }
}

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[OskarLebuda]

@pi0 what do you think about it?

[pi0]

Quickly looking, seems lovely1

[OskarLebuda]

Can we merge this? 😄

[OskarLebuda]

@pi0 Can you merge this PR please? 😄

[pi0]

Dear @OskarLebuda it still needs proper testing before merge (or further change requests). reading this might be good.

[OskarLebuda]

Great! Didn't know about that! I'll check that and get back to you soon! Thanks!

[chadxz]

@OskarLebuda can you allow it to pass other things besides schemas? For example, the 'securitySchemes' component definition is something i'd like to use right now.