Skip to content
New issue

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

Add documentation for action request formats #392

Merged
merged 1 commit into from
Aug 9, 2020
Merged

Add documentation for action request formats #392

merged 1 commit into from
Aug 9, 2020

Conversation

stephendolan
Copy link
Member

@stephendolan stephendolan commented Aug 8, 2020

This PR aims to close #251.

The following items were addressed:

  • Renamed overall "Request" header to include the phrase "Actions" to hopefully show up in search results for "Action"
  • Added a new "Request Formats" section
  • Added a section explaining how to accept and set default request formats
  • Added a section explaining how to write an action to handle/support multiple request formats
  • Opened Clarify accepted_format doc blocks lucky#1234 to address some unclear doc blocks in the framework codebase

This PR aims to close #251.

The following items were addressed:

- Renamed a "Routing and Params" page header to include the phrase "Actions" to hopefully show up in search results for "Action"
- Added a section to the "Requests and Responses" guide explaining how to accept and set default request formats
Copy link
Member

@jwoertink jwoertink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this makes it pretty clear what's going on, and how to customize what you need.

@jwoertink jwoertink merged commit e07df8a into luckyframework:master Aug 9, 2020
Copy link
Member

@paulcsmith paulcsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already merged but just want to say this was super clear and well done. nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document verify_accepted_formats and default_format
3 participants