docs: generate OAS for v2 (#7883)
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,433 @@
|
||||
get:
|
||||
operationId: GetReservations
|
||||
summary: List Reservations
|
||||
description: >-
|
||||
Retrieve a list of reservations. The reservations can be filtered by fields
|
||||
such as `id`. The reservations can also be sorted or paginated.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
data.
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
- name: location_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: location_id
|
||||
description: The reservation's location id.
|
||||
- type: array
|
||||
description: The reservation's location id.
|
||||
items:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The location id's details.
|
||||
- name: inventory_item_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: inventory_item_id
|
||||
description: The reservation's inventory item id.
|
||||
- type: array
|
||||
description: The reservation's inventory item id.
|
||||
items:
|
||||
type: string
|
||||
title: inventory_item_id
|
||||
description: The inventory item id's details.
|
||||
- name: line_item_id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: line_item_id
|
||||
description: The reservation's line item id.
|
||||
- type: array
|
||||
description: The reservation's line item id.
|
||||
items:
|
||||
type: string
|
||||
title: line_item_id
|
||||
description: The line item id's details.
|
||||
- name: created_by
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: created_by
|
||||
description: The reservation's created by.
|
||||
- type: array
|
||||
description: The reservation's created by.
|
||||
items:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The created by's details.
|
||||
- name: description
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: description
|
||||
description: The reservation's description.
|
||||
- type: object
|
||||
description: The reservation's description.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: quantity
|
||||
in: query
|
||||
description: The reservation's quantity.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The reservation's quantity.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: created_at
|
||||
in: query
|
||||
description: The reservation's created at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The reservation's created at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: The reservation's updated at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The reservation's updated at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: deleted_at
|
||||
in: query
|
||||
description: The reservation's deleted at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The reservation's deleted at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_reservations/get.sh
|
||||
tags:
|
||||
- Reservations
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
post:
|
||||
operationId: PostReservations
|
||||
summary: Create Reservation
|
||||
description: Create a reservation.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
data.
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- line_item_id
|
||||
- location_id
|
||||
- inventory_item_id
|
||||
- quantity
|
||||
- description
|
||||
- metadata
|
||||
properties:
|
||||
line_item_id:
|
||||
type: string
|
||||
title: line_item_id
|
||||
description: The reservation's line item id.
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The reservation's location id.
|
||||
inventory_item_id:
|
||||
type: string
|
||||
title: inventory_item_id
|
||||
description: The reservation's inventory item id.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The reservation's quantity.
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
description: The reservation's description.
|
||||
metadata:
|
||||
type: object
|
||||
description: The reservation's metadata.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_reservations/post.sh
|
||||
tags:
|
||||
- Reservations
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
Reference in New Issue
Block a user