[Open API 3.0.*]Does fraction of schema can be referred to the other schema

Question

"components": {"schemas":{"email": {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "title": "Email ",&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "type": "object",&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "description": "Email record.",&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "allOf": [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "$ref": "#/components/schemas/email-event/allOf/0/allOf/0"&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; }&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ]},"email-event": {&nbsp; &nbsp; &nbsp; &nbsp; "title": "",&nbsp; &nbsp; &nbsp; &nbsp; "description": "",&nbsp; &nbsp; &nbsp; &nbsp; "type": "object",&nbsp; &nbsp; &nbsp; &nbsp; "allOf": [&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "title": "Email Event",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "description": "",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "type": "object",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "allOf": [&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "title": "Audit",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "description": "Audit information",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "type": "object",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "properties": {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "created": {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "type": "string",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "format": "date-time",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "example": "2017-01-02T02:00:00Z"&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }&nbsp;Here “Email” schema is using the fractional part of “email-event” schema. Does This is a valid $ref ?

rosecharnley · Answer

Create different possible response schemas and you can use oneOf to allow for different responses. Example below, documentation here: https://support.smartbear.com/swaggerhub/faq/how-to-combine-schemas-in-openapi-specification/

oneOf:

- $ref: '#/components/schemas/objectOne'

- $ref: '#/components/schemas/objectTwo'

Forum Discussion

[Open API 3.0.*]Does fraction of schema can be referred to the other schema

1 Reply

Recent Discussions

Getting a `file` response in OpenAPI v3 / python

JSON to HTML Conversion error

How to Integrate Swagger for jenkins REST API Documentation

Related Content

API references grouping

Could not resolve reference - invalid error

Endpoint takes reference expression literally