Skip to content

Commit 7d15e90

Browse files
meker12meker12
authored
Merge pull request #187 from AdobeDocs/COMOPT-56
Update data-ingestion-schema-v1.yaml
2 parents 22a9b9c + 0b97a6e commit 7d15e90

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

‎src/openapi/data-ingestion-schema-v1.yaml‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ openapi: 3.0.3
22
info:
33
title: Catalog Data Ingestion API
44
description: |
5-
Use the Catalog data ingestion API to create and manage products and price books and directly integrate catalog data with the Commerce catalog service.
5+
The Catalog Data Ingestion API allows you to create and manage products and price books and directly integrate catalog data with the Commerce catalog service.
66
77
This API provides the following resource collections to create and update catalog data:
88
@@ -19,12 +19,12 @@ servers:
1919
tags:
2020
- name: Metadata
2121
description: |
22-
Product attributes metadata allows you to define how to display product attributes on the storefront, define search characteristics, and so on.
22+
Product attribute metadata allows you to define how to display product attributes on the storefront, define search characteristics, and so on.
2323
- name: Products
2424
description: Product API to manage product data
2525
- name: Price Books
2626
description: |
27-
Price books defines a unique scope that can be used to manage product price discounts across customer tiers.
27+
Price books define a unique scope that can be used to manage product price discounts across customer tiers.
2828
You can also specify the currency to use for product prices in the specified price book.
2929
3030
The catalog data model provides a default price book with id `main` and currency in US dollars (`USD`).
@@ -37,7 +37,7 @@ paths:
3737
post:
3838
tags:
3939
- Metadata
40-
summary: Create product attributes metadata
40+
summary: Create product attribute metadata.
4141
description: |
4242
Create or replace existing product attribute metadata resources.
4343
@@ -98,7 +98,7 @@ paths:
9898
"locale": "en"
9999
},
100100
"label": "Product Name",
101-
"dataType": "BOOLEAN",
101+
"dataType": "TEXT",
102102
"visibleIn": ["PRODUCT_DETAIL"],
103103
"filterable": false,
104104
"sortable": false,
@@ -129,7 +129,7 @@ paths:
129129
patch:
130130
tags:
131131
- Metadata
132-
summary: Update product attributes metadata
132+
summary: Update product attribute metadata.
133133
description: |
134134
Update existing product attribute metadata with new values.
135135
When the update is processed, the merge strategy is used to apply changes to `scalar` and `object` type fields. The replace strategy is used to apply changes for fields in an `array`.
@@ -180,10 +180,10 @@ paths:
180180
$ref: '#/components/schemas/FeedMetadataUpdate'
181181
examples:
182182
FeedWithMetadataInformation:
183-
summary: Example of product attributes metadata
183+
summary: Example of product attribute metadata
184184
description: |
185185
Update existing product attribute metadata with new values.
186-
Please note, field with `array` type will replace existing data.
186+
Note that fields with the `array` type will replace existing data.
187187
Example bellow updates the following attributes:
188188
* `label` - Change the product attribute label.
189189
* `visibleIn` - Add `PRODUCT_LISTING` role to the product attribute.
@@ -266,7 +266,7 @@ paths:
266266
$ref: '#/components/schemas/FeedMetadataDelete'
267267
examples:
268268
FeedWithMetadataInformation:
269-
summary: Delete product attributes metadata
269+
summary: Delete product attribute metadata.
270270
description: Marks existing product attribute metadata as deleted.
271271
value:
272272
[
@@ -301,7 +301,7 @@ paths:
301301
post:
302302
tags:
303303
- Products
304-
summary: Create products
304+
summary: Create products.
305305
description: |
306306
<h3>Simple Products</h3>
307307
Create products or replace existing products with a specified `sku` and `scope`.
@@ -345,7 +345,7 @@ paths:
345345
$ref: '#/components/schemas/FeedProduct'
346346
examples:
347347
SimpleProductWithImages:
348-
summary: Create a simple product
348+
summary: Create a simple product.
349349
description: >
350350
Create a simple product with required and optional fields.
351351
value:
@@ -414,7 +414,7 @@ paths:
414414
}
415415
]
416416
ConfigurableProductWithVariants:
417-
summary: Create a configurable product with four product variants
417+
summary: Create a configurable product with four product variants.
418418
description: >
419419
Create a configurable product `pants` with four product variants: `pants-red-32`, `pants-red-44`, `pants-green-32` and `pants-green-44`.
420420
value:
@@ -606,7 +606,7 @@ paths:
606606
patch:
607607
tags:
608608
- Products
609-
summary: Update products
609+
summary: Update products.
610610
description: |
611611
Update products with specified "sku" and "scope" to replace existing field data with the data supplied in the request.
612612
When the update is processed, the merge strategy is used to apply changes to `scalar` and `object` type fields.
@@ -634,7 +634,7 @@ paths:
634634
$ref: '#/components/schemas/FeedProductUpdate'
635635
examples:
636636
SimpleProductWithImages:
637-
summary: Update a simple product
637+
summary: Update a simple product.
638638
description: |
639639
Update a simple product with the values provided in the request.
640640
On update, changes to `scalar` and `object` type fields are applied using the merge strategy.
@@ -676,7 +676,7 @@ paths:
676676
}
677677
]
678678
UnassignProductVariant:
679-
summary: Unassign product variant `pants-red-32` from configurable product `pants`
679+
summary: Unassign product variant `pants-red-32` from configurable product `pants`.
680680
description: |
681681
To unassign product variant `pants-red-32` from configurable product `pants` you need:
682682
* remove the `variantReferenceId` from the `attributes` field
@@ -714,7 +714,7 @@ paths:
714714
post:
715715
tags:
716716
- Products
717-
summary: Delete products
717+
summary: Delete products.
718718
description: >
719719
Delete products with specified "sku" and "scope".
720720
operationId: ProductsDelete
@@ -740,7 +740,7 @@ paths:
740740
$ref: '#/components/schemas/FeedProductDelete'
741741
examples:
742742
DeleteSimpleProduct:
743-
summary: Delete product
743+
summary: Delete product.
744744
description: >
745745
Delete a simple product with a specified `sku` and `scope`.
746746
value:
@@ -757,7 +757,7 @@ paths:
757757
post:
758758
tags:
759759
- Price Books
760-
summary: Create price books
760+
summary: Create price books.
761761
description: |
762762
Create or replace existing price books.
763763
@@ -805,7 +805,7 @@ paths:
805805
$ref: '#/components/schemas/FeedPricebook'
806806
examples:
807807
FeedWithPricebookInformation:
808-
summary: Create a price book
808+
summary: Create a price book.
809809
description: Create a price book and specify the currency for prices.
810810
value:
811811
[
@@ -841,7 +841,7 @@ paths:
841841
patch:
842842
tags:
843843
- Price Books
844-
summary: Update price books
844+
summary: Update price books.
845845
description: |-
846846
Update existing price books to change the name or the currency used for pricing.
847847
When the update is processed, the merge strategy is used to apply changes to `scalar` and `object` type fields. The replace strategy is used to apply changes for fields in an `array`.
@@ -890,7 +890,7 @@ paths:
890890
$ref: '#/components/schemas/FeedPricebook'
891891
examples:
892892
FeedWithPriceBookInformation:
893-
summary: Update existing price books
893+
summary: Update existing price books.
894894
description: Update the "dealer-north" and default "main" price books to change the currency.
895895
value:
896896
[
@@ -926,7 +926,7 @@ paths:
926926
post:
927927
tags:
928928
- Price Books
929-
summary: Delete price books
929+
summary: Delete price books.
930930
description: |
931931
Delete existing price books.
932932
Note that you cannot delete the default price book with id `main`.
@@ -973,7 +973,7 @@ paths:
973973
$ref: '#/components/schemas/FeedPricebook'
974974
examples:
975975
DeleteExistingPricebook:
976-
summary: Delete price book "dealer-north"
976+
summary: Delete price book "dealer-north".
977977
description: Delete the "dealer-north" price book.
978978
value:
979979
[
@@ -1005,7 +1005,7 @@ paths:
10051005
post:
10061006
tags:
10071007
- Prices
1008-
summary: Create prices
1008+
summary: Create prices.
10091009
description: |
10101010
<h3>Simple Products</h3>
10111011
Create or replace existing product prices.
@@ -1059,7 +1059,7 @@ paths:
10591059
$ref: '#/components/schemas/FeedPrices'
10601060
examples:
10611061
FeedWithNewProductPrice:
1062-
summary: Add product price information
1062+
summary: Add product price information.
10631063
description: Add product price information to the catalog data.
10641064
value:
10651065
[
@@ -1107,7 +1107,7 @@ paths:
11071107
patch:
11081108
tags:
11091109
- Prices
1110-
summary: Update prices
1110+
summary: Update prices.
11111111
description: |
11121112
Change existing product prices.
11131113
When the update is processed, the merge strategy is used to apply changes to `scalar` and `object` type fields. The replace strategy is used to apply changes for fields in an `array`.
@@ -1154,7 +1154,7 @@ paths:
11541154
$ref: '#/components/schemas/FeedPricesUpdate'
11551155
examples:
11561156
FeedWithProductPricesInformation:
1157-
summary: Product prices update
1157+
summary: Product prices update.
11581158
description: Update existing product prices for the given SKU ("red-pants") and price book id ("dealer-north").
11591159
value:
11601160
[
@@ -1192,7 +1192,7 @@ paths:
11921192
post:
11931193
tags:
11941194
- Prices
1195-
summary: Delete prices
1195+
summary: Delete prices.
11961196
description: >
11971197
Delete existing product prices
11981198
operationId: PricesDelete
@@ -1238,7 +1238,7 @@ paths:
12381238
$ref: '#/components/schemas/FeedPricesDelete'
12391239
examples:
12401240
FeedWithProductPricesInformation:
1241-
summary: Product prices delete
1241+
summary: Product prices delete.
12421242
description: >
12431243
Delete the existing product prices information
12441244
value:
@@ -1824,7 +1824,7 @@ components:
18241824
description: |
18251825
Type of attribute value to be applied during the rendering phase. Validation occurs only when the code is rendered. Invalid values are ignored.
18261826
- `BOOLEAN`: Accept single value: "true" or false
1827-
- `Number`: Accept single number,e.g. "85", "0.42", etc.
1827+
- `NUMBER`: Accept single number,e.g. "85", "0.42", etc.
18281828
- `STRING`: Accept single string,e.g. "Great day, yall!"
18291829
- `ARRAY`: Accept list of strings ,e.g. ["red", "green", "blue"]
18301830
- `OBJECT`: Accept JSON object `"{"name": "swatch", "color": "red"}"`
@@ -2004,7 +2004,7 @@ components:
20042004
default: FAILED
20052005
message:
20062006
type: string
2007-
description: Error summary
2007+
description: Error summary.
20082008
errors:
20092009
type: array
20102010
description: List of items that did not pass validation. Fix the payload for invalid items before resubmitting the request.

0 commit comments

Comments
 (0)