Replace get_resource_name with get_resource_id
#864
Merged
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
Although the function is named `get_resource_name` in reality it's generating the ID that is used as an id of the resource description as well as in the URLs of apipie. It replaces `.get_resource_name` with `.get_resource_id` to avoid confusion with ResourceDescription#name.
mathieujobin
approved these changes
Apr 13, 2023
stormsilver
added a commit
to rednovalabs/apipie-rails
that referenced
this pull request
May 11, 2023
This should be `get_resource_id`. The method `remove_method_description` was not exercised by the specs so it wasn't caught. (see Apipie#864) This was causing apipie to crash during application boot.
stormsilver
added a commit
to rednovalabs/apipie-rails
that referenced
this pull request
May 12, 2023
This should be `get_resource_id`. The method `remove_method_description` was not exercised by the specs so it wasn't caught. (see Apipie#864) This was causing apipie to crash during application boot. (cherry picked from commit 759009e)
mathieujobin
pushed a commit
that referenced
this pull request
May 12, 2023
This should be `get_resource_id`. The method `remove_method_description` was not exercised by the specs so it wasn't caught. (see #864) This was causing apipie to crash during application boot.
stormsilver
added a commit
to rednovalabs/apipie-rails
that referenced
this pull request
May 24, 2023
This should be `get_resource_id`. The method `ignore_call?` wasn't exercised by the specs so it wasn't caught. (see Apipie#864) This was causing an exception when recording examples.
Merged
mathieujobin
pushed a commit
that referenced
this pull request
May 29, 2023
This should be `get_resource_id`. The method `ignore_call?` wasn't exercised by the specs so it wasn't caught. (see #864) This was causing an exception when recording examples.
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.
Why
Although the function is named
get_resource_namein reality it's generating the ID that is used as an id of the resource description as well as in the URLs of apipie.Ideally what name is displayed in docs should have nothing to do with the internals of Apipie.
How
It deprecates
.get_resource_namein favor of.get_resource_idto avoid confusion withResourceDescription#name