Replace collection objects with array definitions that better translate to Swagger clients
This commit is contained in:
parent
e0a1282338
commit
6a1b2b28f1
1 changed files with 33 additions and 51 deletions
84
openapi.yml
84
openapi.yml
|
@ -54,7 +54,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Availabilities'
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -131,7 +133,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/AppointmentCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/AppointmentRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -302,7 +306,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/UnavailabilityCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/UnavailabilityRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -470,7 +476,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/CustomerCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/CustomerRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -641,7 +649,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ServiceCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/ServiceRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -812,7 +822,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ServiceCategoryCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/ServiceCategoryRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -983,7 +995,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/AdminCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/AdminRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -1154,7 +1168,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/ProviderCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/ProviderRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -1325,7 +1341,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/SecretaryCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/SecretaryRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -1490,7 +1508,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/SettingCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/ServiceRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -1606,7 +1626,9 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/WebhookCollection'
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/WebhookRecord'
|
||||||
'401':
|
'401':
|
||||||
description: Unauthorized
|
description: Unauthorized
|
||||||
'500':
|
'500':
|
||||||
|
@ -1821,10 +1843,6 @@ components:
|
||||||
customerId: 5
|
customerId: 5
|
||||||
providerId: 2
|
providerId: 2
|
||||||
serviceId: 6
|
serviceId: 6
|
||||||
AppointmentCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/AppointmentRecord'
|
|
||||||
UnavailabilityRecord:
|
UnavailabilityRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -1875,10 +1893,6 @@ components:
|
||||||
location: Test Street 1A, 12345 Some State, Some Place
|
location: Test Street 1A, 12345 Some State, Some Place
|
||||||
notes: This is a test appointment.
|
notes: This is a test appointment.
|
||||||
providerId: 2
|
providerId: 2
|
||||||
UnavailabilityCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/UnavailabilityRecord'
|
|
||||||
CustomerRecord:
|
CustomerRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -1978,10 +1992,6 @@ components:
|
||||||
customField4: Value4
|
customField4: Value4
|
||||||
customField5: Value5
|
customField5: Value5
|
||||||
notes: This is a test customer.
|
notes: This is a test customer.
|
||||||
CustomerCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/CustomerRecord'
|
|
||||||
ServiceRecord:
|
ServiceRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -2048,10 +2058,6 @@ components:
|
||||||
availabilitiesType: flexible
|
availabilitiesType: flexible
|
||||||
attendantsNumber: 1
|
attendantsNumber: 1
|
||||||
serviceCategoryId: null
|
serviceCategoryId: null
|
||||||
ServiceCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/ServiceRecord'
|
|
||||||
ServiceCategoryRecord:
|
ServiceCategoryRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -2075,10 +2081,6 @@ components:
|
||||||
example:
|
example:
|
||||||
name: Test Category
|
name: Test Category
|
||||||
description: This is a test category.
|
description: This is a test category.
|
||||||
ServiceCategoryCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/ServiceCategoryRecord'
|
|
||||||
AdminRecord:
|
AdminRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -2187,10 +2189,6 @@ components:
|
||||||
password: Password@123
|
password: Password@123
|
||||||
notifications: true
|
notifications: true
|
||||||
calendarView: default
|
calendarView: default
|
||||||
AdminCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/AdminRecord'
|
|
||||||
ProviderRecord:
|
ProviderRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -2391,10 +2389,6 @@ components:
|
||||||
end: '17:00'
|
end: '17:00'
|
||||||
breaks: [ ]
|
breaks: [ ]
|
||||||
saturday: null
|
saturday: null
|
||||||
ProviderCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/ProviderRecord'
|
|
||||||
SecretaryRecord:
|
SecretaryRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -2516,10 +2510,6 @@ components:
|
||||||
password: Password@123
|
password: Password@123
|
||||||
notifications: true
|
notifications: true
|
||||||
calendarView: default
|
calendarView: default
|
||||||
SecretaryCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/SecretaryRecord'
|
|
||||||
SettingRecord:
|
SettingRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -2537,10 +2527,6 @@ components:
|
||||||
type: string
|
type: string
|
||||||
example:
|
example:
|
||||||
value: ACME Inc
|
value: ACME Inc
|
||||||
SettingCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/SettingRecord'
|
|
||||||
WebhookRecord:
|
WebhookRecord:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -2588,10 +2574,6 @@ components:
|
||||||
secretToken: SecureSecretTokenHere
|
secretToken: SecureSecretTokenHere
|
||||||
isSslVerified: true
|
isSslVerified: true
|
||||||
notes: This is a webhook.
|
notes: This is a webhook.
|
||||||
WebhookCollection:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/WebhookRecord'
|
|
||||||
ErrorResponse:
|
ErrorResponse:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
Loading…
Reference in a new issue