-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathadditionalProperties.oas.yml
68 lines (67 loc) · 1.72 KB
/
additionalProperties.oas.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
openapi: 3.1.0
info:
title: additionalProperties example
description: Demonstrate how to use additionalProperties
version: 1.0.0
paths:
/animals/{id}:
get:
summary: Find animal by ID
description: Returns a single animal
operationId: getAnimalByID
parameters:
- name: id
in: path
description: ID of animal to get
schema:
type: string
required: true
example: "10"
responses:
"200":
description: successful operation
content:
"application/json":
schema:
$ref: '#/components/schemas/Dog'
"400":
description: Invalid ID supplied
content: {}
"404":
description: animal not found
content: {}
components:
schemas:
Dog:
type: object
required:
- name
- owner
- bark
properties:
name:
type: string
owner:
type: string
bark:
type: string
detail: # <- this is the property we wish to allow anything
$ref: "#/components/schemas/AnyJSONObject"
# Workaround definitions to accept any JSON
AnyJSON:
anyOf:
- type: 'null'
- type: string
- type: number
- type: boolean
- $ref: '#/components/schemas/JSONArray'
JSONArray:
type: array
items:
anyOf:
- $ref: "#/components/schemas/AnyJSON" # Array can accept any primitive
- $ref: "#/components/schemas/AnyJSONObject" # or an object with any type
AnyJSONObject:
type: object
additionalProperties:
$ref: "#/components/schemas/AnyJSON"