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

Error examples in template do not match specification #21

Open
warrenfrost opened this issue Jan 28, 2020 · 0 comments
Open

Error examples in template do not match specification #21

warrenfrost opened this issue Jan 28, 2020 · 0 comments

Comments

@warrenfrost
Copy link

warrenfrost commented Jan 28, 2020

Hi,

In the API example templates (JSON and YAML, 2.0 and 3.0), error responses are defined thusly :-

400_error_response:
  description: Bad Request.
  content:
    application/json:
      examples:
        response:
          value: >
            {
              "status": "400",
              "description": "The server cannot process the request.'The specified resource was not found.",
              "more_info": ""
            } 

However the specification for error responses here describes very different field names

https://api.gov.au/standards/national_api_standards/error-handling.html#error-response-payload

Can you please clarify?

Thanks,

Warren

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

No branches or pull requests

1 participant