docs/v2/platform/index.yaml in spree_api-4.3.0.rc1 vs docs/v2/platform/index.yaml in spree_api-4.3.0.rc2
- old
+ new
@@ -22,18 +22,18 @@
example: 50
schema:
type: integer
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: user,country,state
schema:
type: string
- name: filter
in: query
- descripton: ''
+ description: ''
example: user_id_eq=1&firstname_cont=Joh
schema:
type: string
responses:
'200':
@@ -55,12 +55,12 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-06T06:53:18.846Z'
- updated_at: '2021-08-06T06:53:18.846Z'
+ created_at: '2021-08-20T11:02:26.158Z'
+ updated_at: '2021-08-20T11:02:26.158Z'
deleted_at:
label:
relationships:
country:
data:
@@ -83,12 +83,12 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-06T06:53:18.853Z'
- updated_at: '2021-08-06T06:53:18.853Z'
+ created_at: '2021-08-20T11:02:26.166Z'
+ updated_at: '2021-08-20T11:02:26.166Z'
deleted_at:
label:
relationships:
country:
data:
@@ -125,11 +125,11 @@
security:
- bearer_auth: []
parameters:
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: user,country,state
schema:
type: string
responses:
@@ -139,11 +139,11 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '5'
+ id: '1'
type: address
attributes:
firstname: John
lastname: Doe
address1: 5 Lovely Street
@@ -152,22 +152,22 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-06T06:53:19.077Z'
- updated_at: '2021-08-06T06:53:19.077Z'
+ created_at: '2021-08-20T11:02:26.535Z'
+ updated_at: '2021-08-20T11:02:26.535Z'
deleted_at:
label:
relationships:
country:
data:
- id: '4'
+ id: '2'
type: country
state:
data:
- id: '5'
+ id: '1'
type: state
user:
data:
id: '1'
type: user
@@ -214,11 +214,11 @@
required: true
schema:
type: string
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: user,country,state
schema:
type: string
responses:
@@ -228,11 +228,11 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '6'
+ id: '1'
type: address
attributes:
firstname: John
lastname: Doe
address1: 6 Lovely Street
@@ -241,22 +241,22 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-06T06:53:19.150Z'
- updated_at: '2021-08-06T06:53:19.150Z'
+ created_at: '2021-08-20T11:02:26.609Z'
+ updated_at: '2021-08-20T11:02:26.609Z'
deleted_at:
label:
relationships:
country:
data:
- id: '6'
+ id: '1'
type: country
state:
data:
- id: '6'
+ id: '1'
type: state
user:
data:
'404':
description: Record not found
@@ -286,11 +286,11 @@
required: true
schema:
type: string
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: user,country,state
schema:
type: string
responses:
@@ -300,11 +300,11 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '8'
+ id: '1'
type: address
attributes:
firstname: Jack
lastname: Doe
address1: 8 Lovely Street
@@ -313,22 +313,22 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-06T06:53:19.236Z'
- updated_at: '2021-08-06T06:53:19.247Z'
+ created_at: '2021-08-20T11:02:26.706Z'
+ updated_at: '2021-08-20T11:02:26.721Z'
deleted_at:
label:
relationships:
country:
data:
- id: '9'
+ id: '1'
type: country
state:
data:
- id: '8'
+ id: '1'
type: state
user:
data:
'422':
description: invalid request
@@ -413,18 +413,18 @@
example: 50
schema:
type: integer
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: product,taxon
schema:
type: string
- name: filter
in: query
- descripton: ''
+ description: ''
example: taxon_id_eq=1
schema:
type: string
responses:
'200':
@@ -437,12 +437,12 @@
data:
- id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-06T06:53:19.739Z'
- updated_at: '2021-08-06T06:53:19.739Z'
+ created_at: '2021-08-20T11:02:27.225Z'
+ updated_at: '2021-08-20T11:02:27.225Z'
relationships:
product:
data:
id: '1'
type: product
@@ -452,12 +452,12 @@
type: taxon
- id: '2'
type: classification
attributes:
position: 1
- created_at: '2021-08-06T06:53:19.836Z'
- updated_at: '2021-08-06T06:53:19.836Z'
+ created_at: '2021-08-20T11:02:27.336Z'
+ updated_at: '2021-08-20T11:02:27.336Z'
relationships:
product:
data:
id: '2'
type: product
@@ -490,11 +490,11 @@
security:
- bearer_auth: []
parameters:
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: product,taxon
schema:
type: string
responses:
@@ -504,24 +504,24 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '5'
+ id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-06T06:53:20.242Z'
- updated_at: '2021-08-06T06:53:20.242Z'
+ created_at: '2021-08-20T11:02:27.775Z'
+ updated_at: '2021-08-20T11:02:27.775Z'
relationships:
product:
data:
- id: '5'
+ id: '1'
type: product
taxon:
data:
- id: '10'
+ id: '2'
type: taxon
'422':
description: invalid request
content:
application/vnd.api+json:
@@ -552,11 +552,11 @@
required: true
schema:
type: string
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: product,taxon
schema:
type: string
responses:
@@ -566,24 +566,24 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '6'
+ id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-06T06:53:20.399Z'
- updated_at: '2021-08-06T06:53:20.399Z'
+ created_at: '2021-08-20T11:02:27.921Z'
+ updated_at: '2021-08-20T11:02:27.921Z'
relationships:
product:
data:
- id: '6'
+ id: '1'
type: product
taxon:
data:
- id: '12'
+ id: '2'
type: taxon
'404':
description: Record not found
content:
application/vnd.api+json:
@@ -611,11 +611,11 @@
required: true
schema:
type: string
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: product,taxon
schema:
type: string
responses:
@@ -625,24 +625,24 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '8'
+ id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-06T06:53:20.705Z'
- updated_at: '2021-08-06T06:53:20.705Z'
+ created_at: '2021-08-20T11:02:28.202Z'
+ updated_at: '2021-08-20T11:02:28.202Z'
relationships:
product:
data:
- id: '8'
+ id: '1'
type: product
taxon:
data:
- id: '16'
+ id: '2'
type: taxon
'422':
description: invalid request
content:
application/vnd.api+json:
@@ -718,11 +718,11 @@
required: true
schema:
type: string
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: product,taxon
schema:
type: string
responses:
@@ -732,24 +732,24 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '13'
+ id: '1'
type: classification
attributes:
position: 2
- created_at: '2021-08-06T06:53:21.437Z'
- updated_at: '2021-08-06T06:53:21.461Z'
+ created_at: '2021-08-20T11:02:28.904Z'
+ updated_at: '2021-08-20T11:02:28.922Z'
relationships:
product:
data:
- id: '13'
+ id: '1'
type: product
taxon:
data:
- id: '26'
+ id: '2'
type: taxon
'422':
description: invalid request
content:
application/vnd.api+json:
@@ -793,52 +793,52 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- - id: '34'
+ - id: '1'
type: country
attributes:
iso_name: UNITED STATES
iso: US
iso3: IS34
name: United States of America
numcode: 840
states_required: true
- updated_at: '2021-08-06T06:53:21.782Z'
+ updated_at: '2021-08-20T11:02:29.220Z'
zipcode_required: true
- created_at: '2021-08-06T06:53:21.782Z'
+ created_at: '2021-08-20T11:02:29.220Z'
relationships:
states:
data: []
- - id: '35'
+ - id: '2'
type: country
attributes:
iso_name: ISO_NAME_2
iso: I2
iso3: IS35
name: NAME_2
numcode: 840
states_required: false
- updated_at: '2021-08-06T06:53:21.793Z'
+ updated_at: '2021-08-20T11:02:29.229Z'
zipcode_required: true
- created_at: '2021-08-06T06:53:21.793Z'
+ created_at: '2021-08-20T11:02:29.229Z'
relationships:
states:
data: []
- - id: '36'
+ - id: '3'
type: country
attributes:
iso_name: ISO_NAME_3
iso: I3
iso3: IS36
name: NAME_3
numcode: 840
states_required: false
- updated_at: '2021-08-06T06:53:21.796Z'
+ updated_at: '2021-08-20T11:02:29.231Z'
zipcode_required: true
- created_at: '2021-08-06T06:53:21.796Z'
+ created_at: '2021-08-20T11:02:29.231Z'
relationships:
states:
data: []
meta:
count: 3
@@ -878,22 +878,22 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '41'
+ id: '2'
type: country
attributes:
iso_name: ISO_NAME_6
iso: I6
iso3: IS41
name: NAME_6
numcode: 840
states_required: false
- updated_at: '2021-08-06T06:53:21.864Z'
+ updated_at: '2021-08-20T11:02:29.297Z'
zipcode_required: true
- created_at: '2021-08-06T06:53:21.864Z'
+ created_at: '2021-08-20T11:02:29.297Z'
relationships:
states:
data: []
'404':
description: Record not found
@@ -909,10 +909,603 @@
application/vnd.api+json:
examples:
Example:
value:
error: The access token is invalid
+ "/api/v2/platform/option_types":
+ get:
+ summary: Returns a list of OptionTypes
+ tags:
+ - OptionTypes
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: page
+ in: query
+ example: 1
+ schema:
+ type: integer
+ - name: per_page
+ in: query
+ example: 50
+ schema:
+ type: integer
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ''
+ schema:
+ type: string
+ - name: filter
+ in: query
+ description: ''
+ example: option_type_id_eq=1&name_cont=Size
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '1'
+ type: option_type
+ attributes:
+ name: foo-size-1
+ presentation: Size
+ position: 1
+ created_at: '2021-08-20T11:02:29.373Z'
+ updated_at: '2021-08-20T11:02:29.373Z'
+ filterable: true
+ relationships:
+ option_values:
+ data: []
+ - id: '2'
+ type: option_type
+ attributes:
+ name: foo-size-2
+ presentation: Size
+ position: 2
+ created_at: '2021-08-20T11:02:29.375Z'
+ updated_at: '2021-08-20T11:02:29.375Z'
+ filterable: true
+ relationships:
+ option_values:
+ data: []
+ meta:
+ count: 2
+ total_count: 2
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/option_types?page=1&per_page=&include=&filter=
+ next: http://www.example.com/api/v2/platform/option_types?include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/option_types?include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/option_types?include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/option_types?include=&page=1&per_page=
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ post:
+ summary: Creates an OptionType
+ tags:
+ - OptionTypes
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ''
+ schema:
+ type: string
+ responses:
+ '201':
+ description: record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: option_type
+ attributes:
+ name: foo-size-5
+ presentation: Size
+ position: 1
+ created_at: '2021-08-20T11:02:29.453Z'
+ updated_at: '2021-08-20T11:02:29.453Z'
+ filterable: true
+ relationships:
+ option_values:
+ data: []
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank and Presentation can't be blank
+ errors:
+ name:
+ - can't be blank
+ presentation:
+ - can't be blank
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/optiontype_params"
+ "/api/v2/platform/option_types/{id}":
+ get:
+ summary: Returns an OptionType
+ tags:
+ - OptionTypes
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ''
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: option_type
+ attributes:
+ name: foo-size-6
+ presentation: Size
+ position: 1
+ created_at: '2021-08-20T11:02:29.497Z'
+ updated_at: '2021-08-20T11:02:29.497Z'
+ filterable: true
+ relationships:
+ option_values:
+ data: []
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ put:
+ summary: Updates an OptionType
+ tags:
+ - OptionTypes
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ''
+ schema:
+ type: string
+ responses:
+ '200':
+ description: record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: option_type
+ attributes:
+ name: Size-X
+ presentation: Size
+ position: 1
+ created_at: '2021-08-20T11:02:29.580Z'
+ updated_at: '2021-08-20T11:02:29.591Z'
+ filterable: true
+ relationships:
+ option_values:
+ data: []
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/optiontype_params"
+ delete:
+ summary: Deletes an OptionType
+ tags:
+ - OptionTypes
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: Record deleted
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ "/api/v2/platform/option_values":
+ get:
+ summary: Returns a list of OptionValues
+ tags:
+ - OptionValues
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: page
+ in: query
+ example: 1
+ schema:
+ type: integer
+ - name: per_page
+ in: query
+ example: 50
+ schema:
+ type: integer
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: option_type
+ schema:
+ type: string
+ - name: filter
+ in: query
+ description: ''
+ example: option_type_id_eq=1&name_cont=M
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '1'
+ type: option_value
+ attributes:
+ position: 1
+ name: Size-1
+ presentation: S
+ created_at: '2021-08-20T11:02:29.758Z'
+ updated_at: '2021-08-20T11:02:29.758Z'
+ relationships:
+ option_type:
+ data:
+ id: '1'
+ type: option_type
+ - id: '2'
+ type: option_value
+ attributes:
+ position: 1
+ name: Size-2
+ presentation: S
+ created_at: '2021-08-20T11:02:29.763Z'
+ updated_at: '2021-08-20T11:02:29.763Z'
+ relationships:
+ option_type:
+ data:
+ id: '2'
+ type: option_type
+ meta:
+ count: 2
+ total_count: 2
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/option_values?page=1&per_page=&include=&filter=
+ next: http://www.example.com/api/v2/platform/option_values?include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/option_values?include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/option_values?include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/option_values?include=&page=1&per_page=
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ post:
+ summary: Creates an OptionValue
+ tags:
+ - OptionValues
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: option_type
+ schema:
+ type: string
+ responses:
+ '201':
+ description: record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: option_value
+ attributes:
+ position: 1
+ name: Size-5
+ presentation: S
+ created_at: '2021-08-20T11:02:29.842Z'
+ updated_at: '2021-08-20T11:02:29.842Z'
+ relationships:
+ option_type:
+ data:
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank and Presentation can't be blank
+ errors:
+ name:
+ - can't be blank
+ presentation:
+ - can't be blank
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/optionvalue_params"
+ "/api/v2/platform/option_values/{id}":
+ get:
+ summary: Returns an OptionValue
+ tags:
+ - OptionValues
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: option_type
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: option_value
+ attributes:
+ position: 1
+ name: Size-6
+ presentation: S
+ created_at: '2021-08-20T11:02:29.890Z'
+ updated_at: '2021-08-20T11:02:29.890Z'
+ relationships:
+ option_type:
+ data:
+ id: '1'
+ type: option_type
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ put:
+ summary: Updates an OptionValue
+ tags:
+ - OptionValues
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: option_type
+ schema:
+ type: string
+ responses:
+ '200':
+ description: record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: option_value
+ attributes:
+ position: 1
+ name: M
+ presentation: S
+ created_at: '2021-08-20T11:02:29.959Z'
+ updated_at: '2021-08-20T11:02:29.973Z'
+ relationships:
+ option_type:
+ data:
+ id: '1'
+ type: option_type
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank
+ errors:
+ name:
+ - can't be blank
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/optionvalue_params"
+ delete:
+ summary: Deletes an OptionValue
+ tags:
+ - OptionValues
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: Record deleted
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
"/api/v2/platform/taxons":
get:
summary: Returns a list of Taxons
tags:
- Taxons
@@ -929,18 +1522,18 @@
example: 50
schema:
type: integer
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: taxonomy,parent,children
schema:
type: string
- name: filter
in: query
- descripton: ''
+ description: ''
example: taxonomy_id_eq=1&name_cont=Shirts
schema:
type: string
responses:
'200':
@@ -949,21 +1542,56 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- - id: '32'
+ - id: '1'
type: taxon
attributes:
position: 0
+ name: taxonomy_16
+ permalink: taxonomy-16
+ lft: 1
+ rgt: 6
+ description:
+ created_at: '2021-08-20T11:02:30.161Z'
+ updated_at: '2021-08-20T11:02:30.221Z'
+ meta_title:
+ meta_description:
+ meta_keywords:
+ depth: 0
+ pretty_name: taxonomy_16
+ seo_title: taxonomy_16
+ is_root: true
+ is_child: false
+ is_leaf: false
+ relationships:
+ parent:
+ data:
+ taxonomy:
+ data:
+ id: '1'
+ type: taxonomy
+ children:
+ data:
+ - id: '2'
+ type: taxon
+ - id: '3'
+ type: taxon
+ image:
+ data:
+ - id: '2'
+ type: taxon
+ attributes:
+ position: 0
name: taxon_16
permalink: taxonomy-16/taxon-16
lft: 2
rgt: 3
description:
- created_at: '2021-08-06T06:53:21.978Z'
- updated_at: '2021-08-06T06:53:21.982Z'
+ created_at: '2021-08-20T11:02:30.183Z'
+ updated_at: '2021-08-20T11:02:30.187Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_16 -> taxon_16
@@ -972,33 +1600,33 @@
is_child: true
is_leaf: true
relationships:
parent:
data:
- id: '31'
+ id: '1'
type: taxon
taxonomy:
data:
- id: '16'
+ id: '1'
type: taxonomy
children:
data: []
image:
data:
- id: '16'
+ id: '1'
type: taxon_image
- - id: '33'
+ - id: '3'
type: taxon
attributes:
position: 0
name: taxon_17
permalink: taxonomy-16/taxon-17
lft: 4
rgt: 5
description:
- created_at: '2021-08-06T06:53:22.008Z'
- updated_at: '2021-08-06T06:53:22.013Z'
+ created_at: '2021-08-20T11:02:30.208Z'
+ updated_at: '2021-08-20T11:02:30.212Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_16 -> taxon_17
@@ -1007,57 +1635,22 @@
is_child: true
is_leaf: true
relationships:
parent:
data:
- id: '31'
+ id: '1'
type: taxon
taxonomy:
data:
- id: '16'
+ id: '1'
type: taxonomy
children:
data: []
image:
data:
- id: '17'
+ id: '2'
type: taxon_image
- - id: '31'
- type: taxon
- attributes:
- position: 0
- name: taxonomy_16
- permalink: taxonomy-16
- lft: 1
- rgt: 6
- description:
- created_at: '2021-08-06T06:53:21.950Z'
- updated_at: '2021-08-06T06:53:22.027Z'
- meta_title:
- meta_description:
- meta_keywords:
- depth: 0
- pretty_name: taxonomy_16
- seo_title: taxonomy_16
- is_root: true
- is_child: false
- is_leaf: false
- relationships:
- parent:
- data:
- taxonomy:
- data:
- id: '16'
- type: taxonomy
- children:
- data:
- - id: '32'
- type: taxon
- - id: '33'
- type: taxon
- image:
- data:
meta:
count: 3
total_count: 3
total_pages: 1
links:
@@ -1081,11 +1674,11 @@
security:
- bearer_auth: []
parameters:
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: taxonomy,parent,children
schema:
type: string
responses:
@@ -1095,21 +1688,21 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '38'
+ id: '2'
type: taxon
attributes:
position: 0
name: taxon_20
permalink: taxonomy-18/taxon-20
lft: 2
rgt: 3
description:
- created_at: '2021-08-06T06:53:22.225Z'
- updated_at: '2021-08-06T06:53:22.231Z'
+ created_at: '2021-08-20T11:02:30.393Z'
+ updated_at: '2021-08-20T11:02:30.397Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_18 -> taxon_20
@@ -1118,15 +1711,15 @@
is_child: true
is_leaf: true
relationships:
parent:
data:
- id: '37'
+ id: '1'
type: taxon
taxonomy:
data:
- id: '18'
+ id: '1'
type: taxonomy
children:
data: []
image:
data:
@@ -1161,11 +1754,11 @@
required: true
schema:
type: string
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: taxonomy,parent,children
schema:
type: string
responses:
@@ -1175,21 +1768,21 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '40'
+ id: '2'
type: taxon
attributes:
position: 0
name: taxon_21
permalink: taxonomy-19/taxon-21
lft: 2
rgt: 3
description:
- created_at: '2021-08-06T06:53:22.320Z'
- updated_at: '2021-08-06T06:53:22.324Z'
+ created_at: '2021-08-20T11:02:30.484Z'
+ updated_at: '2021-08-20T11:02:30.488Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_19 -> taxon_21
@@ -1198,23 +1791,23 @@
is_child: true
is_leaf: true
relationships:
parent:
data:
- id: '39'
+ id: '1'
type: taxon
taxonomy:
data:
- id: '19'
+ id: '1'
type: taxonomy
children:
data: []
products:
data: []
image:
data:
- id: '20'
+ id: '1'
type: taxon_image
'404':
description: Record not found
content:
application/vnd.api+json:
@@ -1242,11 +1835,11 @@
required: true
schema:
type: string
- name: include
in: query
- descripton: 'Select which associated resources you would like to fetch, see:
+ description: 'Select which associated resources you would like to fetch, see:
<a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
example: taxonomy,parent,children
schema:
type: string
responses:
@@ -1256,21 +1849,21 @@
application/vnd.api+json:
examples:
Example:
value:
data:
- id: '44'
+ id: '2'
type: taxon
attributes:
position: 0
name: T-Shirts
permalink: taxonomy-21/taxon-23
lft: 2
rgt: 3
description:
- created_at: '2021-08-06T06:53:22.511Z'
- updated_at: '2021-08-06T06:53:22.542Z'
+ created_at: '2021-08-20T11:02:30.652Z'
+ updated_at: '2021-08-20T11:02:30.675Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_21 -> T-Shirts
@@ -1279,21 +1872,21 @@
is_child: true
is_leaf: true
relationships:
parent:
data:
- id: '43'
+ id: '1'
type: taxon
taxonomy:
data:
- id: '21'
+ id: '1'
type: taxonomy
children:
data: []
image:
data:
- id: '22'
+ id: '1'
type: taxon_image
'422':
description: invalid request
content:
application/vnd.api+json:
@@ -1354,10 +1947,327 @@
application/vnd.api+json:
examples:
Example:
value:
error: The access token is invalid
+ "/api/v2/platform/users":
+ get:
+ summary: Returns a list of Users
+ tags:
+ - Users
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: page
+ in: query
+ example: 1
+ schema:
+ type: integer
+ - name: per_page
+ in: query
+ example: 50
+ schema:
+ type: integer
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ship_address,bill_address
+ schema:
+ type: string
+ - name: filter
+ in: query
+ description: ''
+ example: user_id_eq=1&email_cont=spree@example.com
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '1'
+ type: user
+ attributes:
+ email: jasper@dooley.co.uk
+ created_at: '2021-08-20T11:02:31.076Z'
+ updated_at: '2021-08-20T11:02:31.076Z'
+ average_order_value: []
+ lifetime_value: []
+ store_credits: []
+ relationships:
+ bill_address:
+ data:
+ ship_address:
+ data:
+ - id: '2'
+ type: user
+ attributes:
+ email: shanice.breitenberg@labadie.ca
+ created_at: '2021-08-20T11:02:31.087Z'
+ updated_at: '2021-08-20T11:02:31.087Z'
+ average_order_value: []
+ lifetime_value: []
+ store_credits: []
+ relationships:
+ bill_address:
+ data:
+ ship_address:
+ data:
+ - id: '3'
+ type: user
+ attributes:
+ email: tristan@reilly.co.uk
+ created_at: '2021-08-20T11:02:31.090Z'
+ updated_at: '2021-08-20T11:02:31.090Z'
+ average_order_value: []
+ lifetime_value: []
+ store_credits: []
+ relationships:
+ bill_address:
+ data:
+ ship_address:
+ data:
+ meta:
+ count: 3
+ total_count: 3
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/users?page=1&per_page=&include=&filter=
+ next: http://www.example.com/api/v2/platform/users?include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/users?include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/users?include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/users?include=&page=1&per_page=
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ post:
+ summary: Creates an User
+ tags:
+ - Users
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ship_address,bill_address
+ schema:
+ type: string
+ responses:
+ '201':
+ description: record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '2'
+ type: user
+ attributes:
+ email: joan@little.info
+ created_at: '2021-08-20T11:02:31.214Z'
+ updated_at: '2021-08-20T11:02:31.214Z'
+ average_order_value: []
+ lifetime_value: []
+ store_credits: []
+ relationships:
+ bill_address:
+ data:
+ ship_address:
+ data:
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Bill address belongs to other user
+ errors:
+ bill_address_id:
+ - belongs to other user
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/user_params"
+ "/api/v2/platform/users/{id}":
+ get:
+ summary: Returns an User
+ tags:
+ - Users
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ship_address,bill_address
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '2'
+ type: user
+ attributes:
+ email: morris@goyettecormier.com
+ created_at: '2021-08-20T11:02:31.290Z'
+ updated_at: '2021-08-20T11:02:31.290Z'
+ average_order_value: []
+ lifetime_value: []
+ store_credits: []
+ relationships:
+ bill_address:
+ data:
+ ship_address:
+ data:
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ put:
+ summary: Updates an User
+ tags:
+ - Users
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ - name: include
+ in: query
+ description: 'Select which associated resources you would like to fetch, see:
+ <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
+ example: ship_address,bill_address
+ schema:
+ type: string
+ responses:
+ '200':
+ description: record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '2'
+ type: user
+ attributes:
+ email: john@example.com
+ created_at: '2021-08-20T11:02:31.401Z'
+ updated_at: '2021-08-20T11:02:31.417Z'
+ average_order_value: []
+ lifetime_value: []
+ store_credits: []
+ relationships:
+ bill_address:
+ data:
+ ship_address:
+ data:
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Bill address belongs to other user
+ errors:
+ bill_address_id:
+ - belongs to other user
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/user_params"
+ delete:
+ summary: Deletes an User
+ tags:
+ - Users
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: Record deleted
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: localhost:3000
@@ -1403,13 +2313,107 @@
type: string
taxon_id:
type: string
position:
type: integer
+ option_type_params:
+ type: object
+ properties:
+ name:
+ type: string
+ presentation:
+ type: string
+ required:
+ - name
+ - presentation
+ option_value_params:
+ type: object
+ properties:
+ name:
+ type: string
+ presentation:
+ type: string
+ option_values_attributes:
+ type: string
+ required:
+ - name
+ - presentation
+ product_params:
+ type: object
+ properties:
+ name:
+ type: string
+ description:
+ type: string
+ available_on:
+ type: string
+ discontinue_on:
+ type: string
+ permalink:
+ type: string
+ meta_description:
+ type: string
+ meta_keywords:
+ type: string
+ price:
+ type: string
+ sku:
+ type: string
+ deleted_at:
+ type: string
+ prototype_id:
+ type: string
+ option_values_hash:
+ type: string
+ weight:
+ type: string
+ height:
+ type: string
+ width:
+ type: string
+ depth:
+ type: string
+ shipping_category_id:
+ type: string
+ tax_category_id:
+ type: string
+ cost_currency:
+ type: string
+ cost_price:
+ type: string
+ compare_at_price:
+ type: string
+ option_type_ids:
+ type: string
+ taxon_ids:
+ type: string
+ required:
+ - name
+ - price
+ - shipping_category_id
+ user_params:
+ type: object
+ properties:
+ email:
+ type: string
+ password:
+ type: string
+ password_confirmation:
+ type: string
+ ship_address_id:
+ type: string
+ bill_address_id:
+ type: string
+ required:
+ - email
+ - password
+ - password_confirmation
taxon_params:
type: object
properties:
taxonomy_id:
+ type: string
+ parent_id:
type: string
name:
type: string
required:
- name