Add infrastructure for Redocly #427
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
keharper
added
enhancement
There was a problem hiding this comment.
FWIW, i recommend moving the OpenAPI spec to a new directory at commerce-extensibility/static/rest/extensibility.yaml or some variation of that. The important thing is to put it in a static/ directory.
That way, you can reference the path to the spec in the redocly block as such:
<RedoclyAPIBlock src='/commerce/extensibility/rest/extensibility.yaml' />
See AdobeDocs/commerce-services#284 for an example.
I think that this will make it easier to validate changes that you make to the spec now and in the future when you deploy to stage. If you use the raw github URL, I think you'll have to update the spec AND update the raw URL in the redocly block, which doesn't seem ideal.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This pull request (PR) adds Redocly variables to the repo and adds a basic yaml file for testing.
Affected pages
Links to Magento Open Source code