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

🎉 Support passing spec a JSON object #5

Merged
merged 1 commit into from
Aug 14, 2020
Merged

🎉 Support passing spec a JSON object #5

merged 1 commit into from
Aug 14, 2020

Conversation

macdonst
Copy link
Contributor

Description

Enhances the OpenAPIBlock to be able to accept a spec object as well as a spec url.

Related Issue

n/a

Motivation and Context

Flexibility mostly. Having the spec in the project will enable it to be enhanced with things like code samples and will enable easier searching.

How Has This Been Tested?

I whipped through the specs at: https://github.com/OAI/OpenAPI-Specification/tree/master/examples

Passing them in as specUrl and spec.

Screenshots (if appropriate):

n/a the page looks the same regardless of the input.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@icaraps icaraps merged commit 2812b18 into main Aug 14, 2020
@icaraps icaraps deleted the redoc branch August 14, 2020 14:42
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.

2 participants