Skip to content

Publish bundled OpenAPI schemas as release assets#1623

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/update-release-workflow-publish-schemas
Draft

Publish bundled OpenAPI schemas as release assets#1623
Copilot wants to merge 2 commits intomainfrom
copilot/update-release-workflow-publish-schemas

Conversation

Copy link
Contributor

Copilot AI commented Mar 11, 2026

Each production release should include self-contained OpenAPI schema files as downloadable assets, with all external $ref references resolved inline.

Changes

  • .github/workflows/release.yml: Added a publish-openapi-schemas job that:
    • Bundles docs/DatabaseCatalogAPI.yaml and docs/DatabaseCatalogTokenAPI.yaml using @redocly/cli, resolving external references such as:
      $ref: "./BearerTokenSchema.yaml#/components/securitySchemes/Authentication"
      into fully inline definitions in the output files.
    • Uploads both bundled YAMLs as GitHub release assets via gh release upload.
    • Runs independently (no deployment job dependency) with contents: write permission scoped to the job.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • otel.cloud.redocly.com
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/.npm/_npx/dfb62dab4341508f/node_modules/.bin/redocly bundle docs/DatabaseCatalogAPI.yaml -o /tmp/bundled-DatabaseCatalogAPI.yaml (dns block)
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/.npm/_npx/1738445911c9ab26/node_modules/.bin/redocly bundle docs/DatabaseCatalogTokenAPI.yaml -o /tmp/bundled-DatabaseCatalogTokenAPI.yaml (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Publish OpenApi schemas on release</issue_title>
<issue_description>### Describe the problem

Publish the OpenAPI schemas on release.

Proposed solution

Update the release.yml workflow so that each release uploads the following OpenAPI schema files as release assets:

Before uploading the files, generate bundled versions of these schemas so that external $ref references are resolved inline in the final release assets.

In particular, references like:

$ref: "./BearerTokenSchema.yaml#/components/securitySchemes/Authentication"

should be replaced in the generated release assets so that the final uploaded OpenAPI files contain the full Authentication security schema instead of a reference to BearerTokenSchema.yaml.

Expected result

  • The GitHub release includes both OpenAPI schema files as downloadable assets.\
  • The uploaded assets are self-contained YAML files.
  • The uploaded files do not depend on local relative references to other schema files.

Alternatives you've considered

No response

Additional context

No response</issue_description>

Comments on the Issue (you are @copilot in this section)


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: davidgamez <1192523+davidgamez@users.noreply.github.com>
Copilot AI changed the title [WIP] Update release workflow to publish OpenAPI schemas Publish bundled OpenAPI schemas as release assets Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish OpenApi schemas on release

2 participants