PLAT-107430-Style/content enhancements for Query Service API swagger[ON HOLD] #63
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
JCON3DEV
changed the title
pnolan89
reviewed
Jan 10, 2022
src/swagger-specs/query-service.yaml
Outdated
Comment on lines
336
to
339
| operationId: "patchSchedule" | ||
| tags: | ||
| - "Schedules" | ||
| summary: Update a schedule | ||
| summary: Partially update a schedule |
There was a problem hiding this comment.
The distinction between patch and update (and specifying that the former is just a partial update) is only relevant if your API has both PUT and PATCH methods for the same endpoint. If it only uses one or the other (as is the case with QS), the verb should always be update, regardless of whether it is a PUT or PATCH request. Same applies to the summary--this should remain as "Update a schedule"
src/swagger-specs/query-service.yaml
Outdated
| @@ -675,6 +678,7 @@ paths: | |||
| tags: | |||
| - "Query-Templates" | |||
| summary: Retrieve a query template | |||
| description: This endpoint retrieves the query template for the `{queryTemplateId}` provided. | |||
There was a problem hiding this comment.
Keep in mind that all path parameters should be stylized in ALL_CAPS_SNAKE_CASE. So in this case, the Swagger parameter itself and all mentions of it in descriptions should appear as {QUERY_TEMPLATE_ID}.
… capitalized the use of ID.
JCON3DEV
changed the title
…uery-Service-API-swagger
JCON3DEV
changed the title
JCON3DEV
changed the title
JCON3DEV
changed the title
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.
(https://jira.corp.adobe.com/browse/PLAT-107430)
wiki: https://wiki.corp.adobe.com/pages/viewpage.action?pageId=2438138911