docs/v2/platform/index.yaml in spree_api-4.3.0.rc2 vs docs/v2/platform/index.yaml in spree_api-4.3.0.rc3
- old
+ new
@@ -55,12 +55,12 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-20T11:02:26.158Z'
- updated_at: '2021-08-20T11:02:26.158Z'
+ created_at: '2021-08-23T21:28:22.108Z'
+ updated_at: '2021-08-23T21:28:22.108Z'
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-20T11:02:26.166Z'
- updated_at: '2021-08-20T11:02:26.166Z'
+ created_at: '2021-08-23T21:28:22.134Z'
+ updated_at: '2021-08-23T21:28:22.134Z'
deleted_at:
label:
relationships:
country:
data:
@@ -152,12 +152,12 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-20T11:02:26.535Z'
- updated_at: '2021-08-20T11:02:26.535Z'
+ created_at: '2021-08-23T21:28:22.275Z'
+ updated_at: '2021-08-23T21:28:22.275Z'
deleted_at:
label:
relationships:
country:
data:
@@ -198,11 +198,11 @@
- can't be blank
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/address_params"
+ "$ref": "#/components/schemas/addresses_params"
"/api/v2/platform/addresses/{id}":
get:
summary: Returns an Address
tags:
- Addresses
@@ -241,12 +241,12 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-20T11:02:26.609Z'
- updated_at: '2021-08-20T11:02:26.609Z'
+ created_at: '2021-08-23T21:28:22.297Z'
+ updated_at: '2021-08-23T21:28:22.297Z'
deleted_at:
label:
relationships:
country:
data:
@@ -313,12 +313,12 @@
zipcode: '35005'
phone: 555-555-0199
state_name:
alternative_phone: 555-555-0199
company: Company
- created_at: '2021-08-20T11:02:26.706Z'
- updated_at: '2021-08-20T11:02:26.721Z'
+ created_at: '2021-08-23T21:28:22.331Z'
+ updated_at: '2021-08-23T21:28:22.336Z'
deleted_at:
label:
relationships:
country:
data:
@@ -361,11 +361,11 @@
error: The access token is invalid
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/address_params"
+ "$ref": "#/components/schemas/addresses_params"
delete:
summary: Deletes an Address
tags:
- Addresses
security:
@@ -437,12 +437,12 @@
data:
- id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-20T11:02:27.225Z'
- updated_at: '2021-08-20T11:02:27.225Z'
+ created_at: '2021-08-23T21:28:22.534Z'
+ updated_at: '2021-08-23T21:28:22.534Z'
relationships:
product:
data:
id: '1'
type: product
@@ -452,12 +452,12 @@
type: taxon
- id: '2'
type: classification
attributes:
position: 1
- created_at: '2021-08-20T11:02:27.336Z'
- updated_at: '2021-08-20T11:02:27.336Z'
+ created_at: '2021-08-23T21:28:22.569Z'
+ updated_at: '2021-08-23T21:28:22.569Z'
relationships:
product:
data:
id: '2'
type: product
@@ -508,12 +508,12 @@
data:
id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-20T11:02:27.775Z'
- updated_at: '2021-08-20T11:02:27.775Z'
+ created_at: '2021-08-23T21:28:22.728Z'
+ updated_at: '2021-08-23T21:28:22.728Z'
relationships:
product:
data:
id: '1'
type: product
@@ -536,11 +536,11 @@
- can't be blank
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/classification_params"
+ "$ref": "#/components/schemas/classifications_params"
"/api/v2/platform/classifications/{id}":
get:
summary: Returns a Classification
tags:
- Classifications
@@ -570,12 +570,12 @@
data:
id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-20T11:02:27.921Z'
- updated_at: '2021-08-20T11:02:27.921Z'
+ created_at: '2021-08-23T21:28:22.787Z'
+ updated_at: '2021-08-23T21:28:22.787Z'
relationships:
product:
data:
id: '1'
type: product
@@ -629,12 +629,12 @@
data:
id: '1'
type: classification
attributes:
position: 1
- created_at: '2021-08-20T11:02:28.202Z'
- updated_at: '2021-08-20T11:02:28.202Z'
+ created_at: '2021-08-23T21:28:22.904Z'
+ updated_at: '2021-08-23T21:28:22.904Z'
relationships:
product:
data:
id: '1'
type: product
@@ -671,11 +671,11 @@
error: The access token is invalid
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/classification_params"
+ "$ref": "#/components/schemas/classifications_params"
delete:
summary: Deletes a Classification
tags:
- Classifications
security:
@@ -736,12 +736,12 @@
data:
id: '1'
type: classification
attributes:
position: 2
- created_at: '2021-08-20T11:02:28.904Z'
- updated_at: '2021-08-20T11:02:28.922Z'
+ created_at: '2021-08-23T21:28:23.191Z'
+ updated_at: '2021-08-23T21:28:23.199Z'
relationships:
product:
data:
id: '1'
type: product
@@ -802,13 +802,13 @@
iso: US
iso3: IS34
name: United States of America
numcode: 840
states_required: true
- updated_at: '2021-08-20T11:02:29.220Z'
+ updated_at: '2021-08-23T21:28:23.328Z'
zipcode_required: true
- created_at: '2021-08-20T11:02:29.220Z'
+ created_at: '2021-08-23T21:28:23.328Z'
relationships:
states:
data: []
- id: '2'
type: country
@@ -817,13 +817,13 @@
iso: I2
iso3: IS35
name: NAME_2
numcode: 840
states_required: false
- updated_at: '2021-08-20T11:02:29.229Z'
+ updated_at: '2021-08-23T21:28:23.332Z'
zipcode_required: true
- created_at: '2021-08-20T11:02:29.229Z'
+ created_at: '2021-08-23T21:28:23.332Z'
relationships:
states:
data: []
- id: '3'
type: country
@@ -832,13 +832,13 @@
iso: I3
iso3: IS36
name: NAME_3
numcode: 840
states_required: false
- updated_at: '2021-08-20T11:02:29.231Z'
+ updated_at: '2021-08-23T21:28:23.333Z'
zipcode_required: true
- created_at: '2021-08-20T11:02:29.231Z'
+ created_at: '2021-08-23T21:28:23.333Z'
relationships:
states:
data: []
meta:
count: 3
@@ -887,13 +887,13 @@
iso: I6
iso3: IS41
name: NAME_6
numcode: 840
states_required: false
- updated_at: '2021-08-20T11:02:29.297Z'
+ updated_at: '2021-08-23T21:28:23.362Z'
zipcode_required: true
- created_at: '2021-08-20T11:02:29.297Z'
+ created_at: '2021-08-23T21:28:23.362Z'
relationships:
states:
data: []
'404':
description: Record not found
@@ -909,10 +909,1059 @@
application/vnd.api+json:
examples:
Example:
value:
error: The access token is invalid
+ "/api/v2/platform/menu_items":
+ get:
+ summary: Returns a list of MenuItems
+ tags:
+ - MenuItems
+ 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: linked_resource
+ schema:
+ type: string
+ - name: filter
+ in: query
+ description: ''
+ example:
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '1'
+ type: menu_item
+ attributes:
+ name: Quia ea unde minus sunt voluptatum iste repellendus.
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Container
+ linked_resource_type: URL
+ code:
+ lft: 1
+ rgt: 16
+ depth: 0
+ created_at: '2021-08-23T21:28:23.403Z'
+ updated_at: '2021-08-23T21:28:23.479Z'
+ link:
+ is_container: true
+ is_root: true
+ is_child: false
+ is_leaf: false
+ relationships:
+ icon:
+ data:
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ linked_resource:
+ data:
+ children:
+ data:
+ - id: '2'
+ type: menu_item
+ - id: '3'
+ type: menu_item
+ - id: '4'
+ type: menu_item
+ - id: '5'
+ type: menu_item
+ - id: '6'
+ type: menu_item
+ - id: '7'
+ type: menu_item
+ - id: '8'
+ type: menu_item
+ - id: '2'
+ type: menu_item
+ attributes:
+ name: Link no. 1 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 2
+ rgt: 3
+ depth: 1
+ created_at: '2021-08-23T21:28:23.414Z'
+ updated_at: '2021-08-23T21:28:23.416Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '1'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ - id: '3'
+ type: menu_item
+ attributes:
+ name: Link no. 2 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 4
+ rgt: 5
+ depth: 1
+ created_at: '2021-08-23T21:28:23.425Z'
+ updated_at: '2021-08-23T21:28:23.426Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '2'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ - id: '4'
+ type: menu_item
+ attributes:
+ name: Link no. 3 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 6
+ rgt: 7
+ depth: 1
+ created_at: '2021-08-23T21:28:23.435Z'
+ updated_at: '2021-08-23T21:28:23.436Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '3'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ - id: '5'
+ type: menu_item
+ attributes:
+ name: Link no. 4 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 8
+ rgt: 9
+ depth: 1
+ created_at: '2021-08-23T21:28:23.444Z'
+ updated_at: '2021-08-23T21:28:23.446Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '4'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ - id: '6'
+ type: menu_item
+ attributes:
+ name: Link no. 5 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 10
+ rgt: 11
+ depth: 1
+ created_at: '2021-08-23T21:28:23.454Z'
+ updated_at: '2021-08-23T21:28:23.456Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '5'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ - id: '7'
+ type: menu_item
+ attributes:
+ name: Link no. 6 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 12
+ rgt: 13
+ depth: 1
+ created_at: '2021-08-23T21:28:23.464Z'
+ updated_at: '2021-08-23T21:28:23.465Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '6'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ - id: '8'
+ type: menu_item
+ attributes:
+ name: Link no. 7 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 14
+ rgt: 15
+ depth: 1
+ created_at: '2021-08-23T21:28:23.474Z'
+ updated_at: '2021-08-23T21:28:23.475Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '7'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ meta:
+ count: 8
+ total_count: 8
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/menu_items?page=1&per_page=&include=&filter=
+ next: http://www.example.com/api/v2/platform/menu_items?include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/menu_items?include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/menu_items?include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/menu_items?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 a MenuItem
+ tags:
+ - MenuItems
+ 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: linked_resource
+ schema:
+ type: string
+ responses:
+ '201':
+ description: record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '5'
+ type: menu_item
+ attributes:
+ name: Link no. 18 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 8
+ rgt: 9
+ depth: 1
+ created_at: '2021-08-23T21:28:23.637Z'
+ updated_at: '2021-08-23T21:28:23.639Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ data: []
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank, Menu can't be blank, and Item type
+ is not included in the list
+ errors:
+ name:
+ - can't be blank
+ menu:
+ - can't be blank
+ item_type:
+ - is not included in the list
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/menu_items_params"
+ "/api/v2/platform/menu_items/{id}":
+ get:
+ summary: Returns a MenuItem
+ tags:
+ - MenuItems
+ 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: linked_resource
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '5'
+ type: menu_item
+ attributes:
+ name: Link no. 25 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 8
+ rgt: 9
+ depth: 1
+ created_at: '2021-08-23T21:28:23.746Z'
+ updated_at: '2021-08-23T21:28:23.748Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '4'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ 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 a MenuItem
+ tags:
+ - MenuItems
+ 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: linked_resource
+ schema:
+ type: string
+ responses:
+ '200':
+ description: record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '5'
+ type: menu_item
+ attributes:
+ name: Menu Item One
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 8
+ rgt: 9
+ depth: 1
+ created_at: '2021-08-23T21:28:23.926Z'
+ updated_at: '2021-08-23T21:28:23.937Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '4'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '1'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ 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/menu_items_params"
+ delete:
+ summary: Deletes a MenuItem
+ tags:
+ - MenuItems
+ 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/menu_items/{id}/reposition":
+ patch:
+ summary: Reposition a Menu Item
+ tags:
+ - MenuItems
+ security:
+ - bearer_auth: []
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '5'
+ type: menu_item
+ attributes:
+ name: Link no. 62 To Somewhere
+ subtitle:
+ destination:
+ new_window: false
+ item_type: Link
+ linked_resource_type: URL
+ code:
+ lft: 5
+ rgt: 6
+ depth: 2
+ created_at: '2021-08-23T21:28:24.309Z'
+ updated_at: '2021-08-23T21:28:24.321Z'
+ link:
+ is_container: false
+ is_root: false
+ is_child: true
+ is_leaf: true
+ relationships:
+ icon:
+ data:
+ id: '4'
+ type: icon
+ menu:
+ data:
+ id: '1'
+ type: menu
+ parent:
+ data:
+ id: '3'
+ type: menu_item
+ linked_resource:
+ data:
+ children:
+ 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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/menu_item_reposition_params"
+ "/api/v2/platform/menus":
+ get:
+ summary: Returns a list of Menus
+ tags:
+ - Menus
+ 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: menu_items
+ schema:
+ type: string
+ - name: filter
+ in: query
+ description: ''
+ example: location_eq=header
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '1'
+ type: menu
+ attributes:
+ name: Main Menu
+ location: header
+ locale: en
+ created_at: '2021-08-23T21:28:24.436Z'
+ updated_at: '2021-08-23T21:28:24.464Z'
+ relationships:
+ menu_items:
+ data:
+ - id: '1'
+ type: menu_item
+ - id: '3'
+ type: menu_item
+ - id: '4'
+ type: menu_item
+ - id: '2'
+ type: menu
+ attributes:
+ name: Footer Menu
+ location: footer
+ locale: en
+ created_at: '2021-08-23T21:28:24.440Z'
+ updated_at: '2021-08-23T21:28:24.484Z'
+ relationships:
+ menu_items:
+ data:
+ - id: '2'
+ type: menu_item
+ - id: '5'
+ type: menu_item
+ - id: '6'
+ type: menu_item
+ meta:
+ count: 2
+ total_count: 2
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/menus?page=1&per_page=&include=&filter=
+ next: http://www.example.com/api/v2/platform/menus?include=&page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/menus?include=&page=1&per_page=
+ last: http://www.example.com/api/v2/platform/menus?include=&page=1&per_page=
+ first: http://www.example.com/api/v2/platform/menus?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 a Menu
+ tags:
+ - Menus
+ 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: menu_items
+ schema:
+ type: string
+ responses:
+ '201':
+ description: record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: menu
+ attributes:
+ name: Main Menu
+ location: header
+ locale: en
+ created_at: '2021-08-23T21:28:24.595Z'
+ updated_at: '2021-08-23T21:28:24.598Z'
+ relationships:
+ menu_items:
+ data:
+ - id: '1'
+ type: menu_item
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank, Locale can't be blank, and Location
+ is not included in the list
+ errors:
+ name:
+ - can't be blank
+ locale:
+ - can't be blank
+ location:
+ - is not included in the list
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/menus_params"
+ "/api/v2/platform/menus/{id}":
+ get:
+ summary: Returns a Menu
+ tags:
+ - Menus
+ 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: menu_items
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: menu
+ attributes:
+ name: Main Menu
+ location: header
+ locale: en
+ created_at: '2021-08-23T21:28:24.622Z'
+ updated_at: '2021-08-23T21:28:24.625Z'
+ relationships:
+ menu_items:
+ data:
+ - id: '1'
+ type: menu_item
+ '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 a Menu
+ tags:
+ - Menus
+ 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: menu_items
+ schema:
+ type: string
+ responses:
+ '200':
+ description: record updated
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: menu
+ attributes:
+ name: Main Menu
+ location: header
+ locale: en
+ created_at: '2021-08-23T21:28:24.664Z'
+ updated_at: '2021-08-23T21:28:24.667Z'
+ relationships:
+ menu_items:
+ data:
+ - id: '1'
+ type: menu_item
+ '422':
+ description: invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name can't be blank, Locale can't be blank, and Location
+ is not included in the list
+ errors:
+ name:
+ - can't be blank
+ locale:
+ - can't be blank
+ location:
+ - is not included in the list
+ '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/menus_params"
+ delete:
+ summary: Deletes a Menu
+ tags:
+ - Menus
+ 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_types":
get:
summary: Returns a list of OptionTypes
tags:
- OptionTypes
@@ -955,24 +2004,24 @@
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'
+ created_at: '2021-08-23T21:28:24.774Z'
+ updated_at: '2021-08-23T21:28:24.774Z'
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'
+ created_at: '2021-08-23T21:28:24.775Z'
+ updated_at: '2021-08-23T21:28:24.775Z'
filterable: true
relationships:
option_values:
data: []
meta:
@@ -1020,12 +2069,12 @@
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'
+ created_at: '2021-08-23T21:28:24.807Z'
+ updated_at: '2021-08-23T21:28:24.807Z'
filterable: true
relationships:
option_values:
data: []
'422':
@@ -1043,11 +2092,11 @@
- can't be blank
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/optiontype_params"
+ "$ref": "#/components/schemas/option_types_params"
"/api/v2/platform/option_types/{id}":
get:
summary: Returns an OptionType
tags:
- OptionTypes
@@ -1079,12 +2128,12 @@
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'
+ created_at: '2021-08-23T21:28:24.829Z'
+ updated_at: '2021-08-23T21:28:24.829Z'
filterable: true
relationships:
option_values:
data: []
'404':
@@ -1135,12 +2184,12 @@
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'
+ created_at: '2021-08-23T21:28:24.867Z'
+ updated_at: '2021-08-23T21:28:24.871Z'
filterable: true
relationships:
option_values:
data: []
'422':
@@ -1172,11 +2221,11 @@
error: The access token is invalid
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/optiontype_params"
+ "$ref": "#/components/schemas/option_types_params"
delete:
summary: Deletes an OptionType
tags:
- OptionTypes
security:
@@ -1250,12 +2299,12 @@
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'
+ created_at: '2021-08-23T21:28:24.950Z'
+ updated_at: '2021-08-23T21:28:24.950Z'
relationships:
option_type:
data:
id: '1'
type: option_type
@@ -1263,12 +2312,12 @@
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'
+ created_at: '2021-08-23T21:28:24.952Z'
+ updated_at: '2021-08-23T21:28:24.952Z'
relationships:
option_type:
data:
id: '2'
type: option_type
@@ -1317,12 +2366,12 @@
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'
+ created_at: '2021-08-23T21:28:24.988Z'
+ updated_at: '2021-08-23T21:28:24.988Z'
relationships:
option_type:
data:
'422':
description: invalid request
@@ -1339,11 +2388,11 @@
- can't be blank
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/optionvalue_params"
+ "$ref": "#/components/schemas/option_values_params"
"/api/v2/platform/option_values/{id}":
get:
summary: Returns an OptionValue
tags:
- OptionValues
@@ -1375,12 +2424,12 @@
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'
+ created_at: '2021-08-23T21:28:25.015Z'
+ updated_at: '2021-08-23T21:28:25.015Z'
relationships:
option_type:
data:
id: '1'
type: option_type
@@ -1432,12 +2481,12 @@
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'
+ created_at: '2021-08-23T21:28:25.052Z'
+ updated_at: '2021-08-23T21:28:25.056Z'
relationships:
option_type:
data:
id: '1'
type: option_type
@@ -1470,11 +2519,11 @@
error: The access token is invalid
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/optionvalue_params"
+ "$ref": "#/components/schemas/option_values_params"
delete:
summary: Deletes an OptionValue
tags:
- OptionValues
security:
@@ -1551,12 +2600,12 @@
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'
+ created_at: '2021-08-23T21:28:25.145Z'
+ updated_at: '2021-08-23T21:28:25.172Z'
meta_title:
meta_description:
meta_keywords:
depth: 0
pretty_name: taxonomy_16
@@ -1586,12 +2635,12 @@
name: taxon_16
permalink: taxonomy-16/taxon-16
lft: 2
rgt: 3
description:
- created_at: '2021-08-20T11:02:30.183Z'
- updated_at: '2021-08-20T11:02:30.187Z'
+ created_at: '2021-08-23T21:28:25.156Z'
+ updated_at: '2021-08-23T21:28:25.157Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_16 -> taxon_16
@@ -1621,12 +2670,12 @@
name: taxon_17
permalink: taxonomy-16/taxon-17
lft: 4
rgt: 5
description:
- created_at: '2021-08-20T11:02:30.208Z'
- updated_at: '2021-08-20T11:02:30.212Z'
+ created_at: '2021-08-23T21:28:25.167Z'
+ updated_at: '2021-08-23T21:28:25.168Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_16 -> taxon_17
@@ -1697,12 +2746,12 @@
name: taxon_20
permalink: taxonomy-18/taxon-20
lft: 2
rgt: 3
description:
- created_at: '2021-08-20T11:02:30.393Z'
- updated_at: '2021-08-20T11:02:30.397Z'
+ created_at: '2021-08-23T21:28:25.251Z'
+ updated_at: '2021-08-23T21:28:25.254Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_18 -> taxon_20
@@ -1738,11 +2787,11 @@
- can't be blank
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/taxon_params"
+ "$ref": "#/components/schemas/taxons_params"
"/api/v2/platform/taxons/{id}":
get:
summary: Returns a Taxon
tags:
- Taxons
@@ -1777,12 +2826,12 @@
name: taxon_21
permalink: taxonomy-19/taxon-21
lft: 2
rgt: 3
description:
- created_at: '2021-08-20T11:02:30.484Z'
- updated_at: '2021-08-20T11:02:30.488Z'
+ created_at: '2021-08-23T21:28:25.291Z'
+ updated_at: '2021-08-23T21:28:25.293Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_19 -> taxon_21
@@ -1858,12 +2907,12 @@
name: T-Shirts
permalink: taxonomy-21/taxon-23
lft: 2
rgt: 3
description:
- created_at: '2021-08-20T11:02:30.652Z'
- updated_at: '2021-08-20T11:02:30.675Z'
+ created_at: '2021-08-23T21:28:25.371Z'
+ updated_at: '2021-08-23T21:28:25.383Z'
meta_title:
meta_description:
meta_keywords:
depth: 1
pretty_name: taxonomy_21 -> T-Shirts
@@ -1915,11 +2964,11 @@
error: The access token is invalid
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/taxon_params"
+ "$ref": "#/components/schemas/taxons_params"
delete:
summary: Deletes a Taxon
tags:
- Taxons
security:
@@ -1990,13 +3039,13 @@
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'
+ email: vernetta@huels.co.uk
+ created_at: '2021-08-23T21:28:25.546Z'
+ updated_at: '2021-08-23T21:28:25.546Z'
average_order_value: []
lifetime_value: []
store_credits: []
relationships:
bill_address:
@@ -2004,13 +3053,13 @@
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'
+ email: pansy_hirthe@smitham.us
+ created_at: '2021-08-23T21:28:25.549Z'
+ updated_at: '2021-08-23T21:28:25.549Z'
average_order_value: []
lifetime_value: []
store_credits: []
relationships:
bill_address:
@@ -2018,13 +3067,13 @@
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'
+ email: carmen.kerluke@kossschulist.com
+ created_at: '2021-08-23T21:28:25.550Z'
+ updated_at: '2021-08-23T21:28:25.550Z'
average_order_value: []
lifetime_value: []
store_credits: []
relationships:
bill_address:
@@ -2073,13 +3122,13 @@
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'
+ email: marx_feil@borer.info
+ created_at: '2021-08-23T21:28:25.597Z'
+ updated_at: '2021-08-23T21:28:25.597Z'
average_order_value: []
lifetime_value: []
store_credits: []
relationships:
bill_address:
@@ -2099,11 +3148,11 @@
- belongs to other user
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/user_params"
+ "$ref": "#/components/schemas/users_params"
"/api/v2/platform/users/{id}":
get:
summary: Returns an User
tags:
- Users
@@ -2132,13 +3181,13 @@
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'
+ email: stefany@leannon.biz
+ created_at: '2021-08-23T21:28:25.626Z'
+ updated_at: '2021-08-23T21:28:25.626Z'
average_order_value: []
lifetime_value: []
store_credits: []
relationships:
bill_address:
@@ -2191,12 +3240,12 @@
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'
+ created_at: '2021-08-23T21:28:25.669Z'
+ updated_at: '2021-08-23T21:28:25.673Z'
average_order_value: []
lifetime_value: []
store_credits: []
relationships:
bill_address:
@@ -2232,11 +3281,11 @@
error: The access token is invalid
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/user_params"
+ "$ref": "#/components/schemas/users_params"
delete:
summary: Deletes an User
tags:
- Users
security:
@@ -2417,9 +3466,52 @@
name:
type: string
required:
- name
- taxonomy_id
+ menu_params:
+ type: object
+ properties:
+ name:
+ type: string
+ location:
+ type: string
+ locale:
+ type: string
+ required:
+ - name
+ - location
+ - locale
+ menu_item_params:
+ type: object
+ properties:
+ name:
+ type: string
+ code:
+ type: string
+ subtitle:
+ type: string
+ destination:
+ type: string
+ new_window:
+ type: boolean
+ item_type:
+ type: string
+ linked_resource_type:
+ type: string
+ linked_resource_id:
+ type: integer
+ required:
+ - name
+ menu_item_reposition_params:
+ type: object
+ properties:
+ new_parent_id:
+ type: integer
+ new_position_idx:
+ type: integer
+ required:
+ - name
resources_list:
type: object
properties:
data:
type: array