docs/v2/platform/index.yaml in spree_api-4.5.5 vs docs/v2/platform/index.yaml in spree_api-4.6.0
- old
+ new
@@ -2198,10 +2198,286 @@
Example:
value:
error: The access token is invalid
schema:
"$ref": "#/components/schemas/error"
+ "/api/v2/platform/data_feeds":
+ get:
+ summary: Return a list of Data Feeds
+ tags:
+ - Data Feeds
+ security:
+ - bearer_auth: [ ]
+ operationId: data-feeds-list
+ parameters:
+ - name: page
+ in: query
+ example: 1
+ schema:
+ type: integer
+ - name: per_page
+ in: query
+ example: 50
+ schema:
+ type: integer
+ responses:
+ '200':
+ description: Records returned
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ - id: '1'
+ type: data_feed
+ attributes:
+ name: First Data Feed
+ type: Spree::DataFeed::Google
+ slug: e593ae1f-630a-4f77-832f-0489da1c921b
+ active: true
+ - id: '2'
+ type: data_feed
+ attributes:
+ name: Second Data Feed
+ type: Spree::DataFeed::Google
+ slug: 52f060f2-76cf-4983-89a3-714419941463
+ active: true
+ meta:
+ count: 2
+ total_count: 2
+ total_pages: 1
+ links:
+ self: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+ next: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+ prev: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+ last: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+ first: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+ schema:
+ "$ref": "#/components/schemas/resources_list"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ post:
+ summary: Create a Data Feed
+ tags:
+ - Data Feeds
+ security:
+ - bearer_auth: [ ]
+ description: Creates a Data Feed
+ operationId: create-data-feed
+ parameters: [ ]
+ responses:
+ '201':
+ description: Record created
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: data_feed
+ attributes:
+ name: First Data Feed
+ type: Spree::DataFeed::Google
+ slug: e593ae1f-630a-4f77-832f-0489da1c921b
+ active: true
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Data Feed name can't be blank
+ errors:
+ name:
+ - can't be blank
+ type:
+ - can't be blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/create_data_feed_params"
+ "/api/v2/platform/data_feeds/{id}":
+ get:
+ summary: Return a Data Feed
+ tags:
+ - Data Feeds
+ security:
+ - bearer_auth: [ ]
+ description: Returns a Data Feed
+ operationId: show-data-feed
+ parameters:
+ - name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Record found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ data:
+ id: '1'
+ type: data_feed
+ attributes:
+ name: First Data Feed
+ type: Spree::DataFeed::Google
+ slug: e593ae1f-630a-4f77-832f-0489da1c921b
+ active: true
+ relationships:
+ store:
+ data:
+ id: '1'
+ type: store
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ patch:
+ summary: Update a Data Feed
+ tags:
+ - Data Feeds
+ security:
+ - bearer_auth: [ ]
+ description: Updates a Data Feed
+ operationId: update-data-feed
+ 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: '1'
+ type: data_feed
+ attributes:
+ name: First Data Feed
+ type: Spree::DataFeed::Google
+ slug: e593ae1f-630a-4f77-832f-0489da1c921b
+ active: true
+ schema:
+ "$ref": "#/components/schemas/resource"
+ '422':
+ description: Invalid request
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: Name is blank
+ errors:
+ name:
+ - is blank
+ schema:
+ "$ref": "#/components/schemas/validation_errors"
+ '404':
+ description: Record not found
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The resource you were looking for could not be found.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/update_data_feed_params"
+ delete:
+ summary: Delete a Data Feed
+ tags:
+ - Data Feeds
+ security:
+ - bearer_auth: [ ]
+ description: Deletes a Data Feed
+ operationId: delete-data-feed
+ 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.
+ schema:
+ "$ref": "#/components/schemas/error"
+ '401':
+ description: Authentication Failed
+ content:
+ application/vnd.api+json:
+ examples:
+ Example:
+ value:
+ error: The access token is invalid
+ schema:
+ "$ref": "#/components/schemas/error"
"/api/v2/platform/digital_links":
get:
summary: Return a list of Digital Links
tags:
- Digital Links
@@ -15488,10 +15764,11 @@
type: user
attributes:
email: ivonne.braun@smith.biz
first_name: Liberty
last_name: Becker
+ selected_locale: nil
created_at: '2022-11-08T19:35:53.726Z'
updated_at: '2022-11-08T19:35:53.726Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -15506,10 +15783,11 @@
type: user
attributes:
email: lenita.mayer@kulas.us
first_name: Chasidy
last_name: Strosin
+ selected_locale: 'fr'
created_at: '2022-11-08T19:35:53.730Z'
updated_at: '2022-11-08T19:35:53.730Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -15524,10 +15802,11 @@
type: user
attributes:
email: dewayne@terrybarton.info
first_name: Ruben
last_name: Schmidt
+ selected_locale: 'de'
created_at: '2022-11-08T19:35:53.732Z'
updated_at: '2022-11-08T19:35:53.732Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -15589,10 +15868,11 @@
type: user
attributes:
email: rex_champlin@breitenberg.com
first_name: Zenia
last_name: King
+ selected_locale: 'pl'
created_at: '2022-11-08T19:35:54.351Z'
updated_at: '2022-11-08T19:35:54.351Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -15658,10 +15938,11 @@
type: user
attributes:
email: gaynell@parisian.biz
first_name: Irwin
last_name: DuBuque
+ selected_locale: 'en'
created_at: '2022-11-08T19:35:54.635Z'
updated_at: '2022-11-08T19:35:54.635Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -15728,10 +16009,11 @@
type: user
attributes:
email: john@example.com
first_name: Astrid
last_name: Kohler
+ selected_locale: 'fr'
created_at: '2022-11-08T19:35:55.180Z'
updated_at: '2022-11-08T19:35:55.414Z'
public_metadata: {}
private_metadata: {}
average_order_value: []
@@ -17667,11 +17949,11 @@
"$ref": "#/components/schemas/error"
servers:
- url: http://{defaultHost}
variables:
defaultHost:
- default: localhost:3000
+ default: localhost:4000
tags:
- name: Addresses
- name: Adjustments
- name: Classifications
- name: Countries
@@ -19177,10 +19459,52 @@
content.
required:
- cms_section
title: Update a Rich Text Section
x-internal: false
+ create_data_feed_params:
+ type: object
+ properties:
+ data_feed:
+ type: object
+ required:
+ - name
+ - type
+ properties:
+ name:
+ type: string
+ example: 'First data feed'
+ slug:
+ type: string
+ example: 'first-data-feed'
+ type:
+ type: string
+ example: 'Spree::DataFeed::Google'
+ active:
+ type: boolean
+ x-internal: false
+ update_data_feed_params:
+ type: object
+ properties:
+ data_feed:
+ type: object
+ required:
+ - name
+ - type
+ properties:
+ name:
+ type: string
+ example: 'First data feed'
+ slug:
+ type: string
+ example: 'first-data-feed'
+ type:
+ type: string
+ example: 'Spree::DataFeed::Google'
+ active:
+ type: boolean
+ x-internal: false
create_digital_params:
type: object
properties:
digital[attachment]:
type: string
@@ -21336,10 +21660,12 @@
type: string
password:
type: string
password_confirmation:
type: string
+ selected_locale:
+ type: string
ship_address_id:
type: string
bill_address_id:
type: string
public_metadata:
@@ -21362,9 +21688,11 @@
last_name:
type: string
password:
type: string
password_confirmation:
+ type: string
+ selected_locale:
type: string
ship_address_id:
type: string
bill_address_id:
type: string