Support use x-* in ref#1776
Merged
Merged
Conversation
Collaborator
|
Interesting - I didn't even know you can nest complex structures in |
Collaborator
|
Thanks @krissss |
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
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.
The above annotation will generate
x-custom-keyin the OpenAPI document.However, we need to get ref of
x-custom-keywith$openapi->ref('#/components/schemas/String/x/custom-key')(note that here we usex/custom-keyinstead ofx-custom-key).This is not conducive to writing ref in the code ourselves. For example,
This will generate the following incorrect documentation when using
$openapi->toYaml()(usex/custom-key)... application/json: schema: $ref: '#/components/schemas/String/x/custom-key' ...Therefore, we have to write it in the following way (use
x-custom-key)However, if it is written directly in the above way, the validation will fail.
This PR is to fix this issue to support the use of ref
x-*.