Same ref example in methods not working

[petrkasnal]

Hi,

i'm try use same example over ref in few methods and it isn't work.

Example.yml
test: 'ok'

items.yml

post:
  summary: Import items 
  responses:
    '401':
      description: 'Unauthorized'
      content:
        application/json:
          schema:
            $ref: '../BaseSchemas/ApiResult.yml'
          example:
            $ref: '../BaseExamples/UnauthorizedExample.yml'

get:
  summary: Get all items
  responses:
    '401':
      description: 'Unauthorized'
      content:
        application/json:
          schema:
            $ref: '../BaseSchemas/ApiResult.yml'
          example:
            $ref: '../BaseExamples/UnauthorizedExample.yml'

And result show this
Post:

Get:

[MikeRalphson]

What tool are you using which doesn't work? This repository is for the OpenAPI specification itself.

[petrkasnal]

@MikeRalphson Swagger but i dont know if openapi write correctly

[hkosova]

@petrkasnal The example keyword (singular form) does not support $ref, you need to specify the entire example value inline.

The examples keyword (plural form) supports both $ref (to reference an Example Object definition) and externalValue (to "import" the example value from an external file). The syntax for examples+$ref is:

      content:
        application/json:
          schema:
            $ref: '../BaseSchemas/ApiResult.yml'
          examples:
            UnauthorizedExample:
              $ref: '#/components/examples/UnauthorizedExample'

components:
  examples:
    UnauthorizedExample:
      summary: An example of a 401 Unauthorized response
      value:
        code: 401
        message: The 'Authorization' header is missing or contains an invalid value.

and the externalValue syntax is as follows (but Swagger UI does this support this yet):

      content:
        application/json:
          schema:
            $ref: '../BaseSchemas/ApiResult.yml'
          examples:
            UnauthorizedExample:
              summary: An example of a 401 Unauthorized response
              externalValue: '../examples/UnauthorizedExample.json'

// UnauthorizedExample.json

{
  "code": 401,
  "message": "The 'Authorization' header is missing or contains an invalid value."
}

[petrkasnal]

@hkosova ok thank you very much for your help :)