Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CO-890 Updates the catalogs API documentation #4348

Merged
merged 14 commits into from
Nov 8, 2022
Merged

CO-890 Updates the catalogs API documentation #4348

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3cfc289
first pass of updating the catalogs api documentation
raghavnarain3 Nov 2, 2022
a9667b7
nit
raghavnarain3 Nov 2, 2022
5038a76
nit test
raghavnarain3 Nov 2, 2022
610a067
cleanup
raghavnarain3 Nov 3, 2022
278889d
last cleanup
raghavnarain3 Nov 3, 2022
4886989
fix last table
raghavnarain3 Nov 3, 2022
963f8f8
done
raghavnarain3 Nov 3, 2022
62b1b9d
pr updates
raghavnarain3 Nov 3, 2022
2fb2f0f
last cleanup
raghavnarain3 Nov 3, 2022
0c8d74f
Doc edits
lydia-xie Nov 7, 2022
555fdd0
Minor edit
lydia-xie Nov 7, 2022
6ba3b59
Minor style edits
lydia-xie Nov 7, 2022
10ce1f4
Engineering feedback
lydia-xie Nov 8, 2022
701edfe
Minor edit
lydia-xie Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ..._api/endpoints/catalogs/catalog_items/asynchronous/delete_catalog_items_bulk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The status code `202` could return the following response body.

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion .../_api/endpoints/catalogs/catalog_items/asynchronous/patch_catalog_items_bulk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The status code `202` could return the following response body.

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion ...endpoints/catalogs/catalog_items/asynchronous/post_create_catalog_items_bulk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The status code `202` could return the following response body.

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion _docs/_api/endpoints/catalogs/catalog_items/synchronous/delete_catalog_item.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The status code `202` could return the following response body.

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
10 changes: 5 additions & 5 deletions ...s/_api/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ If you'd like to share your feedback on this endpoint or make a request, contact

This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints.

## Request parameters

There is no request body for this endpoint.

## Path parameters

| Parameter | Required | Data Type | Description |
Expand All @@ -39,6 +35,10 @@ There is no request body for this endpoint.
| `item_id` | Required | String | The ID of the catalog item. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

## Request parameters

There is no request body for this endpoint.

## Example request

```
Expand Down Expand Up @@ -74,7 +74,7 @@ The status code `200` could return the following response body.

### Example error response

The status code `404` could return the following response. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `404` could return the following response. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
10 changes: 5 additions & 5 deletions .../endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ If you'd like to share your feedback on this endpoint or make a request, contact

This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints.

## Request parameters

There is no request body for this endpoint.

## Path parameters

| Parameter | Required | Data Type | Description |
Expand All @@ -47,6 +43,10 @@ Note that each call to this endpoint will return 50 items. For a catalog with mo
| `cursor` | Optional | String | Determines the pagination of the catalog items. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

## Request parameters

There is no request body for this endpoint.

## Example requests

### Without cursor
Expand Down Expand Up @@ -118,7 +118,7 @@ Link: </catalogs/all_restaurants/items?cursor=c2tpcDow>; rel="prev",</catalogs/a

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion _docs/_api/endpoints/catalogs/catalog_items/synchronous/patch_catalog_item.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The status code `200` could return the following response body.

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion ...s/_api/endpoints/catalogs/catalog_items/synchronous/post_create_catalog_item.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The status code `201` could return the following response body.

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down
12 changes: 6 additions & 6 deletions _docs/_api/endpoints/catalogs/catalog_management/synchronous/delete_catalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ If you'd like to share your feedback on this endpoint or make a request, contact

This endpoint has a shared rate limit of 5 requests per minute between all synchronous catalog endpoints.

## Request parameters

There is no request body for this endpoint.

## Path parameters

| Parameter | Required | Data Type | Description |
|---|---|---|---|
| `catalog_name` | Required | String | Name of the catalog. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

## Request parameters

There is no request body for this endpoint.

## Example request

```
Expand All @@ -62,7 +62,7 @@ The status code `200` could return the following response body.

### Example error response

The status code `404` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `404` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand All @@ -82,7 +82,7 @@ The status code `404` could return the following response body. Refer to [API er
}
```

## Troubleshooting
## Troubleshooting

The following table lists possible returned errors and their associated troubleshooting steps.

Expand Down
4 changes: 4 additions & 0 deletions _docs/_api/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ If you'd like to share your feedback on this endpoint or make a request, contact

This endpoint has a shared rate limit of 5 requests per minute between all synchronous catalog endpoints.

## Request parameters
lydia-xie marked this conversation as resolved.
Show resolved Hide resolved

There is no request body for this endpoint.

### Example request

```
Expand Down
2 changes: 1 addition & 1 deletion ...s/_api/endpoints/catalogs/catalog_management/synchronous/post_create_catalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ The status code `201` could return the following response body.

### Example error response

The status code `400` could return the following response body. Refer to [API errors and responses]({{site.baseurl}}/api/errors/) for more infomation about various errors and server responses.
The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.

```json
{
Expand Down