clarify hidden option in readme #593
Merged
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
LeFnord
requested changes
Mar 7, 2017
README.md
Outdated
| @@ -438,10 +438,10 @@ desc "Return super-secret information", { | |||
| <a name="hiding" /> | |||
| #### Hiding an Endpoint | |||
|
|
|||
| You can hide an endpoint by adding ```hidden: true``` in the description of the endpoint: | |||
| You can hide an endpoint by adding ```hidden: true``` on the verb method of the endpoint, such as `get`, `post` and `put`: | |||
There was a problem hiding this comment.
@thogg4 … thanks for contribution …
please don't replace existed documentation, it is still correct, only add additional possibility to hide an endpoint
|
Hey @LeFnord I couldn't get the existing example to work, but as requested I added it back. The readme now has both. |
|
thanks @thogg4 … yeah the example … what I mean is this version to hide an endpoint: desc 'put specific foo', hidden: true
put ':id' do
# your code goes here
endand your version of it – this is new to me 😉 patch ':id', hidden:true do
# your code goes here
end |
LeFnord
approved these changes
Mar 7, 2017
LeFnord
pushed a commit
to LeFnord/grape-swagger
that referenced
this pull request
Feb 9, 2019
* clarify hidden option in readme * update changelog * add both ways to hide an endpoint
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.
No description provided.