Forum Discussion

pmong's avatar
pmong
New Contributor
6 years ago

Sharable error codes across APIs

I'm trying to create a page for error codes with examples which can be used across various APIs. All these error codes have the same structure, which has attributes statusCode and statusMsg.   I h...
HKosova's avatar
HKosova
SmartBear Alumni (Retired)
6 years ago

Hi pmong,

 

In OpenAPI 2.0, response examples can be specified using the examples.<media-type> keyword. Check out the Adding Examples guide for more information.

responses:
  CONF001:
    description: Configuration error
    schema:
      $ref: '#/definitions/ErrorModel'
    examples:
      application/json:
        statusCode: CONF.001
        statusMsg: Configuration error

Also, references to response definition (not schema definitions) should be like this:

        400:
          $ref: 'https://api.swaggerhub.com/domains/xxx/ErrorCodesDomain/1#/responses/DATA001' 

After these changes your response example should work fine.