Improve summaries and descriptions for each endpoint #57
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
bcbogdan
force-pushed
the
feat/add-more-details
branch
2 times, most recently
from
a30c775 to
842633d
Compare
bcbogdan
force-pushed
the
feat/add-more-details
branch
from
842633d to
a73d73f
Compare
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.
Summary
The following PR improves the explanations for each endpoint in order to make the spec easier to understand for the end user.
The following changes have been added:
Tenant ID parameter format was changed from , to {tenantId}, in description and all URL paths.
This was done to have consistency in how we present path parameters in our documentation.
Summary fields have been added on all the endpoints
Each. response schema now has a title and a description