How to make swagger examples component with allOf

Question

components:
 examples:
    J:
      value:
        name: my name
        
    J2:
      value:
        allOf: 
          - $ref: '#/components/examples/J'
          - id: 123

Use J2 in response body examples:

responses:
  200:
    content:
      application/json:
        examples:
          test:
            $ref: '#/components/examples/J2'

Current result:

{
  "$ref": "#/components/examples/J",
  "id": 123
}

Expected result

{
  "name": "my name",
  "id": 123
}

Related: https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/

Swagger schema properties ignored when using $ref - why?

score 1 · Answer 1 · answered Feb 11 '22 at 14:17

1

This is not supported.

The value is meant to be the literal value of the example. As a result, value does not support allOf and $ref. OpenAPI does not have a way to merge the values of multiple example components.

answered Feb 11 '22 at 14:17

Helen

87,344
17
243
314

So, I have to create another component for just add one element. – Ertuğrul Altınboğa Feb 13 '22 at 15:26
@ErtuğrulAltınboğa yes. Feel free to open an enhancement request in the OpenAPI Specification repository: https://github.com/OAI/OpenAPI-Specification/issues – Helen Feb 13 '22 at 15:39

score -1 · Answer 2 · answered Sep 06 '22 at 13:06

You cannot combine at example level but you can combine examples at path level.

This is invalid

components:
 examples:
    J:
      value:
        name: my name
        
    J2:
      value:
        allOf: 
          - $ref: '#/components/examples/J'
          - id: 123

But you can do this

components:
 examples:
    J:
      value:
        name: my name
        
    J2:
      value:
        id: 123

content:
  application/json:
    schema:
      $ref: '#/components/schemas/MyObject'
    examples:
      objectExample:
        allOf :
         - $ref: '#/components/examples/J'
         - $ref: '#/components/examples/J2'

How to make swagger examples component with allOf

2 Answers2