EDU-12745 | Update Marketplace APIs - Suggestions #3833
Annotations
42 errors and 75 warnings
must-include-response-examples:
VTEX - Marketplace APIs - Suggestions.json#L335
At least one example should be included for each API response
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L437
Each array field must contain an "items" property.
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L241
Each array field must contain an "items" property.
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L233
Each array field must contain an "items" property.
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L389
Each array field must contain an "items" property.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1630
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1681
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1747
Each request or response body property must contain a description.
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L1770
Each array field must contain an "items" property.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1595
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1608
Each request or response body property must contain a description.
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L1774
Each array field must contain an "items" property.
|
must-include-response-examples:
VTEX - Marketplace APIs - Suggestions.json#L1581
At least one example should be included for each API response
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1834
Each request or response body property must contain a description.
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L1780
Each array field must contain an "items" property.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1965
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1803
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1790
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2055
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2029
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1968
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2103
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2081
Each request or response body property must contain a description.
|
oas3-valid-schema-example:
VTEX - Marketplace APIs - Suggestions.json#L2320
"specifications" property must have required property "Embalagem"
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2360
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L1972
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2244
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2325
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2343
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2181
Each request or response body property must contain a description.
|
array-items:
VTEX - Marketplace APIs - Suggestions.json#L2325
Each array field must contain an "items" property.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2430
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2427
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2221
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2358
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2425
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2438
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2446
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2434
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2453
Each request or response body property must contain a description.
|
properties-description:
VTEX - Marketplace APIs - Suggestions.json#L2442
Each request or response body property must contain a description.
|
Run Spectral
fatal issues detected. Failing the process.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L28
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L183
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L102
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L384
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L103
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L184
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L27
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L469
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L549
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L282
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L338
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L283
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L784
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L630
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L935
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L1066
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L550
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L934
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L707
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L1210
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L470
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L1137
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L1283
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L1368
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L708
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L1511
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L1138
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L629
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L1211
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1667
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L1510
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
summaries-should-be-in-sentence-case:
VTEX - Marketplace APIs - Suggestions.json#L1367
All endpoint summaries should use sentence case (capitalize only the first letter) and never contain periods (`.`). Exceptions include product names and some specific terms (e.g., SKU, ID).
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L1067
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1635
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1690
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1866
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
endpoint-permissions:
VTEX - Marketplace APIs - Suggestions.json#L1284
Endpoint descriptions must include a "Permissions" section, with information about License Manager resources and roles.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1907
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1947
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1827
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1796
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1874
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1673
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1956
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L1761
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1922
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1951
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1917
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1972
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1870
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2121
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1965
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2111
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2088
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2349
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2244
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2386
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2293
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2432
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L2381
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
request-body-properties-example:
VTEX - Marketplace APIs - Suggestions.json#L1968
Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2459
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2436
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2448
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2494
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2469
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2489
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2464
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2444
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2499
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2479
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2484
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2511
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2440
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|
response-body-objects-arrays-example:
VTEX - Marketplace APIs - Suggestions.json#L2504
Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
|