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

Fixes README.md responses example typo "unprocessible" #248

Merged
merged 1 commit into from
Jul 8, 2020
Merged

Fixes README.md responses example typo "unprocessible" #248

merged 1 commit into from
Jul 8, 2020

Conversation

gdiasdasilva
Copy link
Contributor

@gdiasdasilva gdiasdasilva commented Jul 8, 2020

This PR fixes #247.

The current responses example has a typo in what should be unprocessable_entity (currently unprocessible) according to the documentation of Plug.Conn.Status, making it to not compile when trying to directly follow the example.

Example of the issue:

  @doc responses: [
    ok: {"User", "application/json", MyAppWeb.Schema.User}
    unprocessible_entity: {"Bad request parameters", "application/json", MyAppWeb.Schema.BadRequestParameters},
    not_found: {"Not found", "application/json", MyAppWeb.Schema.NotFound}
  ]

@gdiasdasilva gdiasdasilva changed the title Fixes responses example typo "unprocessible" Fixes README.md responses example typo "unprocessible" Jul 8, 2020
@moxley moxley merged commit cb4c08c into open-api-spex:master Jul 8, 2020
@moxley
Copy link
Contributor

moxley commented Jul 8, 2020

Nice catch @gdiasdasilva. Thank you!

@mbuhot mbuhot added this to the v3.8 milestone Aug 20, 2020
@moxley moxley mentioned this pull request Aug 21, 2020
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.

README.md typo in responses example (unprocessible_entity vs unprocessable_entity)
3 participants