search

apigovau / national-api-design-standards

Australian National API Design Standards
35 stars 15 forks source link

Error examples in template do not match specification #21

Open warrenfrost opened 4 years ago

warrenfrost commented 4 years ago

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