How to define a component as an array of another component in Open API?

Question

I would like to define two components: one for a single student and one for an array of students. But I want to follow the DRY principle. So I tried this:

components:
  schemas:
    student:
      type: object
      properties:
        StudentID:
          type: integer
          example: 3
        StudentName:
          type: string
          example: David
        StudentRemarks:
          type: string
          example: High Grade Student
    students:
      type: array
      items:
        $ref: '#/components/schemas/student/properties'

But it does not seem to work. Swaggers editor renders it this way:

If I repeat myself:

components:
  schemas:
    student:
      type: object
      properties:
        StudentID:
          type: integer
          example: 3
        StudentName:
          type: string
          example: David
        StudentRemarks:
          type: string
          example: High Grade Student
    students:
      type: array
      items:
        properties:
          StudentID:
            type: integer
            example: 3
          StudentName:
            type: string
            example: David
          StudentRemarks:
            type: string
            example: High Grade Student

It looks this way:

When I try to define a named anchor, I get the following error:

Structural error at components.schemas.student
should NOT have additional properties
additionalProperty: $id

How to reference another component correctly?

MikeRalphson · Accepted Answer · 2021-07-22 10:45:53Z

4

Your $ref goes one level too deep. You need to point to a schema (or subschema) not the properties object within a schema.

    students:
      type: array
      items:
        $ref: '#/components/schemas/student'

answered Jul 22, 2021 at 10:45

MikeRalphson

2,4332 gold badges16 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to define a component as an array of another component in Open API?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related