fix(docs): Do not mix POST create and POST search.#115
Open
fyodorklimenko wants to merge 1 commit intomainfrom
Open
fix(docs): Do not mix POST create and POST search.#115fyodorklimenko wants to merge 1 commit intomainfrom
fyodorklimenko wants to merge 1 commit intomainfrom
Conversation
The request `POST https://api.spscommerce.com/v1/books` looks like a create operation, not a search. Suggesting using the word `search`: `POST https://api.spscommerce.com/v1/books/search`. "Search" is a neutral and generic term. It does not introduce extra semantic constraints, but it clearly describes the purpose of the endpoint. Signed-off-by: Fedir Klymenko <fklymenko@spscommerce.com>
|
It is actually in line with our Actions guidelines. If it gets approved, we may want to reference that section from here. But why limit the list to |
markdebeer
approved these changes
Mar 13, 2026
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
3 participants
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 request
POST https://api.spscommerce.com/v1/bookslooks like a create operation, not a search.Suggesting using the word
search:POST https://api.spscommerce.com/v1/books/search."Search" is a neutral and generic term.
It does not introduce extra semantic constraints, but it clearly describes the purpose of the endpoint.