Highlight the role of the :id binding in cowboy route
#75
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
* https://github.com/inaka/sumo_rest/blob/0.3.3/src/sr_state.erl#L42 * Function spec may be further detailed, but that would require type spec and new internal type (for mandatory key); * Having a field and exported function for id is enough. * https://github.com/inaka/sumo_rest/blob/0.3.3/src/sr_single_entity_handler.erl#L43 * It already comments on the :id element of cowboy route clearly. * https://github.com/inaka/sumo_rest/blob/0.3.3/src/sr_request.erl#L18 * Added internal type for documentation purpose. * https://github.com/inaka/sumo_db/blob/0.7.1/src/sumo_internal.erl#L88 * See inaka/sumo_db#294 * https://github.com/inaka/sumo_rest/blob/0.3.3/test/sr_test/sr_single_session_handler.erl#L60 and https://github.com/inaka/sumo_rest/blob/0.3.3/test/sr_test/sr_single_element_handler.erl#L66 * They already mention `:id` clearly; * The only source of confusion may be whether the name of the parameter in the Swagger schema e.g. [this](https://github.com/inaka/sumo_rest/blob/0.3.3/test/sr_test/sr_single_element_handler.erl#L33) needed to be called `id` e.g. in case cowboy_swagger enforces it. * https://github.com/inaka/sumo_rest/blob/0.3.3/README.md * It already mentions `:id` clearly.
lucafavatella
changed the title
:id binding in cowboy route:id binding in cowboy route
|
@lucafavatella you are correct. The entity id must be called |
|
I'll merge this PR and we can deal with having different binding fields in #78 |
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.
Does the name of the parameter in the Swagger schema e.g. this need to be called
ide.g. in case cowboy_swagger enforces it?Please refer to the commit message for details.
See also inaka/sumo_db#294