A language for describing resource-oriented APIs & turning them into Swagger or resource diagrams. Oriented around the concepts we want to expose in the APIs.
Apache License 2.0
23
stars
7
forks
source link
Remove "search" terminology from generated pagination documentation #166
The generated descriptions for pagination parameters and responses include overly-specific references to "search". E.g. "It allows the next request to begin from where the current search left off."
The pagination concepts should be more general, just talking about fetching the next page. The word "search" is not universally descriptive of all possible paginated endpoints. Some may not support searching or even filtering, and might just be simple lists.
To Reproduce
generate any spec with a cursor paginated endpoint and read the docs
Expected Behavior
Pagination is not coupled to the concept of search, and just refers to pages.
Describe The Bug
The generated descriptions for pagination parameters and responses include overly-specific references to "search". E.g. "It allows the next request to begin from where the current search left off."
The pagination concepts should be more general, just talking about fetching the next page. The word "search" is not universally descriptive of all possible paginated endpoints. Some may not support searching or even filtering, and might just be simple lists.
To Reproduce
generate any spec with a cursor paginated endpoint and read the docs
Expected Behavior
Pagination is not coupled to the concept of search, and just refers to pages.
Reslang Version
Master/Latest