Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specifying a $ref in the info.description section #840

Open
micheledicosmo opened this issue Nov 19, 2024 · 0 comments
Open

Specifying a $ref in the info.description section #840

micheledicosmo opened this issue Nov 19, 2024 · 0 comments

Comments

@micheledicosmo
Copy link

I need to specify an external reference ($ref) in the info.description section to refer to an external documentation file.

The use case is for integrating with documentation generators which read those references, however info.description cannot be an object and has to be a string according to the current version.

For example:
https://docs.bump.sh/help/enhance-documentation-content/markdown-support/

is expecting this:

openapi: 3.1.0
info:
  title: Bump API documentation
  version: 1.0.0
  description:
    $ref: "./docs/introduction.md"
servers:
  ...
paths:
  ...
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

No branches or pull requests

1 participant