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

Add support for importing non yaml files as block's #1262

Closed
jdarling opened this issue Jul 12, 2017 · 5 comments
Closed

Add support for importing non yaml files as block's #1262

jdarling opened this issue Jul 12, 2017 · 5 comments
Labels
Needs author feedback No recent activity The issue has not been updated in 7 days. re-use: ref/id resolution how $ref, operationId, or anything else is resolved

Comments

@jdarling
Copy link

Currently there is no (easy) way to define an external file that is not a yaml file. It would be nice to have something like the ability to include an arbitrary file as a text block into a definition. For example you could extract the descriptions into their own .md file, or code samples into their own . files for inclusion.

This could be done as either an extension of $ref's ability to include files or as a new directive.

@darrelmiller
Copy link
Member

Autorest has an interesting alternative way of blending markdown and OpenAPI descriptions. https://github.com/Azure/autorest/blob/master/Samples/3a-literate-swagger/swagger.md

For examples you can use externalValue to point to any kind of document.

@handrews handrews added the $ref label Feb 24, 2020
@michael-o
Copy link

Autorest has an interesting alternative way of blending markdown and OpenAPI descriptions. https://github.com/Azure/autorest/blob/master/Samples/3a-literate-swagger/swagger.md

For examples you can use externalValue to point to any kind of document.

This link is dead now.

@MikeRalphson
Copy link
Member

Thanks. The reference file appears to have been moved to https://github.com/Azure/autorest/blob/master/Samples/openapi-v2/3a-literate-swagger/swagger.md

@handrews handrews added re-use re-use: ref/id resolution how $ref, operationId, or anything else is resolved and removed $ref labels Jan 29, 2024
@handrews
Copy link
Member

Does the External Documentation Object solve this problem?

@github-actions github-actions bot added the No recent activity The issue has not been updated in 7 days. label May 31, 2024
Copy link
Contributor

This issue has been labeled with No recent activity because there has been no recent activity. It will be closed if no further activity occurs within 28 days. Please re-open this issue or open a new one after this delay if you need to.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs author feedback No recent activity The issue has not been updated in 7 days. re-use: ref/id resolution how $ref, operationId, or anything else is resolved
Projects
None yet
Development

No branches or pull requests

5 participants