Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

(many tickets): [update] Catalog, final updates before file split #1275

Merged
merged 4 commits into from
Apr 17, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
65 changes: 35 additions & 30 deletions reference/catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,8 @@ paths:
examples:
example-1:
value:
- name: Smith Journal 13
- id: 0
name: Smith Journal 13
type: physical
sku: SM-13
description: '<p><span>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.</span></p>'
Expand Down Expand Up @@ -14974,14 +14975,17 @@ paths:
parameters:
- name: id
in: query
description: |
Filter items by id.
description: Filter items by ID.
schema:
type: integer
- name: sku
in: query
description: |
Filter items by sku.
description: Filter items by SKU.
schema:
type: string
- name: upc
in: query
description: Filter items by UPC.
schema:
type: string
- name: page
Expand All @@ -14996,12 +15000,12 @@ paths:
type: integer
- name: include_fields
in: query
description: 'Fields to include, in a comma-separated list. The ID and the specified fields will be returned.'
description: Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
schema:
type: string
- name: exclude_fields
in: query
description: 'Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.'
description: Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
schema:
type: string
- name: product_id
Expand Down Expand Up @@ -19989,7 +19993,7 @@ components:
- type: object
properties:
errors:
$ref: '#/components/schemas/detailedErrors'
$ref: '#/components/schemas/DetailedErrors'
x-internal: false
error_Base:
title: error_Base
Expand Down Expand Up @@ -20026,7 +20030,7 @@ components:
type: string
description: A BigCommerce-defined error signifier.
errors:
$ref: '#/components/schemas/detailedErrors'
$ref: '#/components/schemas/DetailedErrors'
errorNotFound:
title: errorNotFound
type: object
Expand Down Expand Up @@ -20099,8 +20103,8 @@ components:
type: string
description: No-content response for the BigCommerce API.
x-internal: false
detailedErrors:
title: detailedErrors
DetailedErrors:
title: DetailedErrors
description: Each key-value pair describes a failure or partial success case.
type: object
properties: {}
Expand Down Expand Up @@ -20207,12 +20211,21 @@ components:
title: product_Put_Collection
description: The model for batch updating products.
x-internal: false
allOf:
- items:
$ref: '#/components/schemas/product_Base'
items:
allOf:
- type: object
properties:
id:
type: integer
description: Unique ID of the *Product*. Read-Only.
readOnly: true
required:
- id
- $ref: '#/components/schemas/product_Base'
x-examples:
example-1:
- name: Smith Journal 13
- id: 0
name: Smith Journal 13
type: physical
sku: SM-13
description: '<p><span>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.</span></p>'
Expand Down Expand Up @@ -21156,7 +21169,7 @@ components:
- type: object
properties:
errors:
$ref: '#/components/schemas/detailedErrors'
$ref: '#/components/schemas/DetailedErrors'
x-internal: false
errorResponse_422:
title: errorResponse_422
Expand All @@ -21175,7 +21188,7 @@ components:
- type: object
properties:
errors:
$ref: '#/components/schemas/detailedErrors'
$ref: '#/components/schemas/DetailedErrors'
x-internal: false
productSortOrder:
title: productSortOrder
Expand Down Expand Up @@ -21377,7 +21390,7 @@ components:
- type: object
properties:
errors:
$ref: '#/components/schemas/betadetailedErrors'
$ref: '#/components/schemas/betaDetailedErrors'
title: errorResponse_Full
x-tags:
- Models
Expand Down Expand Up @@ -21437,9 +21450,9 @@ components:
title: errorNoContent
x-tags:
- Models
betadetailedErrors:
betaDetailedErrors:
type: object
title: detailedErrors
title: DetailedErrors
properties: {}
additionalProperties: true
x-tags:
Expand All @@ -21459,7 +21472,7 @@ components:
type: string
- properties:
errors:
$ref: '#/components/schemas/betadetailedErrors'
$ref: '#/components/schemas/betaDetailedErrors'
type: object
x-tags:
- Models
Expand All @@ -21478,7 +21491,7 @@ components:
type: string
- properties:
errors:
$ref: '#/components/schemas/betadetailedErrors'
$ref: '#/components/schemas/betaDetailedErrors'
type: object
x-tags:
- Models
Expand Down Expand Up @@ -21725,14 +21738,6 @@ components:
example: '?limit=5&page=3'
x-tags:
- Models
DetailedErrors:
description: |
Details of errors.
type: object
properties: {}
additionalProperties: true
x-tags:
- Models
ErrorRequest:
type: object
properties:
Expand Down