This repository has been archived by the owner on Jan 21, 2020. It is now read-only.
add operation id to documentation #393
Merged
Conversation
This file contains 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
This was referenced Jul 31, 2018
weierophinney
suggested changes
Jul 31, 2018
src/Model/DocumentationModel.php
Outdated
| 'PUT' => ['description' => null, 'request' => null, 'response' => null], | ||
| 'PATCH' => ['description' => null, 'request' => null, 'response' => null], | ||
| 'DELETE' => ['description' => null, 'request' => null, 'response' => null], | ||
| 'GET' => ['operationId' => null, 'description' => null, 'request' => null, 'response' => null], |
There was a problem hiding this comment.
My primary concern with adding this field is that it is highly specific to Swagger. Does API Blueprint have a similar feature? If so, we can generalize this so that it has meaning across all supported documentation type.
There was a problem hiding this comment.
On API Blueprint, the equivalent is "identifier" => https://apiblueprint.org/documentation/specification.html#section-structure
So should we use identifier instead of operationId ? Or just id ?
There was a problem hiding this comment.
I'd argue identifier, and then zf-apigility-documentation-swagger and zf-apigility-documentation-apiblueprint would translate it to the appropriate key.
weierophinney
approved these changes
Apr 4, 2019
A number of lines in `getSchemaTemplate()` exceeded the max line length. This patch adds comments for disabling CS checks in that method.
|
Thanks, @garygitton! |
This was referenced Dec 31, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I added this field to be able to personalized methods of the sdks generated with swagger-codegen and zf-apigility-documentation-swagger.