We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
See https://github.com/ruby-grape/grape/blob/master/lib/grape/dsl/desc.rb. We should expose:
headers
hidden
deprecated
produces
consumes
http_codes
entity
success
Here's an idea on format:
### `GET /resources` Description first, append a period unless `ends_with?(/[[:punct:]]/)`. - **Status**: **DEPRECATED** - **Resource**: Array of [Mock:Foo](#mock-foo) - **Security**: `required=["foo/bar.baz", "foo/bar.qux"]` **Content Types**: - **Consumes**: `application/json`, `application/yaml` - **Produces**: `application/json`, `application/pdf` **Headers**: - **X-Auth-Token**: Validates your identity (required) - **Per-Page**: number of items per page **Params**: | Field | Type | Description | | -------------------- | ---------- | ---------------------------------------- |
Omit sections if there's no informations about the,
The text was updated successfully, but these errors were encountered:
No branches or pull requests
See https://github.com/ruby-grape/grape/blob/master/lib/grape/dsl/desc.rb. We should expose:
headers
- HTTP headers this method can accepthidden
- hide endpoint from doc if setdeprecated
produces
+consumes
- MIME typeshttp_codes
- we should expose thisentity
- please note thatsuccess
is now just an alias, we should useentity
insteadHere's an idea on format:
Omit sections if there's no informations about the,
The text was updated successfully, but these errors were encountered: