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

Update Operation IDs to be consistent & programmatic #1469

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions reference/abandoned_cart_emails.v3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ paths:
meta: {}
tags:
- Abandoned Cart Emails
summary: Get all email templates
operationId: getAbandonedCartEmails
summary: Get all abandoned cart email templates
operationId: getAbandonedCartEmailTemplates
post:
summary: Create email template
operationId: createEmailTemplate
summary: Create abandoned cart email template
operationId: createAbandonedCartEmailTemplate
tags:
- Abandoned Cart Emails
responses:
Expand Down Expand Up @@ -124,11 +124,11 @@ paths:
$ref: '#/components/schemas/metaCollection_open'
tags:
- Abandoned Cart Emails
operationId: getAbandonedCartEmailTemplateId
operationId: getAbandonedCartEmailTemplate
put:
summary: Update an email template
description: Update an email template.
operationId: updateAbandonedCartEmailsId
operationId: updateAbandonedCartEmailTemplate
tags:
- Abandoned Cart Emails
responses:
Expand Down Expand Up @@ -184,7 +184,7 @@ paths:
- Abandoned Cart Emails
description: Delete Abandoned Cart Email template.
summary: Delete email template
operationId: deleteAbandonedCartEmailTemplateId
operationId: deleteAbandonedCartEmailTemplate
responses:
'204':
description: No Content
Expand Down Expand Up @@ -270,7 +270,7 @@ paths:
- $ref: '#/components/parameters/ChannelIdRequired'
put:
summary: Update email template settings
operationId: updateEmailTemplateSettings
operationId: updateAbandonedCartEmailTemplateSettings
tags:
- Template settings
responses:
Expand Down
14 changes: 4 additions & 10 deletions reference/abandoned_carts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,6 @@ paths:
tags:
- Abandoned Carts Settings
parameters:
- name: channel_id
description: The channel ID of the settings overrides
in: path
required: true
schema:
type: integer
- $ref: '#/components/parameters/ContentType'
requestBody:
required: true
Expand Down Expand Up @@ -154,13 +148,13 @@ paths:
$ref: '#/components/schemas/ErrorResponse'
security: []
parameters:

- $ref: '#/components/parameters/Accept'
- schema:
type: string
name: channel_id
- name: channel_id
description: The channel ID of the settings overrides
in: path
required: true
schema:
type: integer
'/abandoned-carts/{token}':
get:
responses:
Expand Down
8 changes: 4 additions & 4 deletions reference/carts.sf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ paths:
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.

operationId: getACart
operationId: getCart
parameters:
- $ref: '#/components/parameters/include'
responses:
Expand All @@ -48,7 +48,7 @@ paths:
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.

operationId: createACart
operationId: createCart
parameters:
- $ref: '#/components/parameters/include'
requestBody:
Expand Down Expand Up @@ -84,7 +84,7 @@ paths:
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.

operationId: deleteACart
operationId: deleteCart
parameters:
- name: cartId
in: path
Expand Down Expand Up @@ -293,7 +293,7 @@ paths:
> #### Note
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.
operationId: addCartCurrency
operationId: updateCartCurrency
parameters:
- name: cartId
in: path
Expand Down
18 changes: 9 additions & 9 deletions reference/carts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ paths:
'201':
$ref: '#/components/responses/CartResponse'
summary: Create a Cart
operationId: createACart
operationId: createCart
'/carts/{cartId}/items':
parameters:
- $ref: '#/components/parameters/cartId'
Expand Down Expand Up @@ -344,7 +344,7 @@ paths:
'201':
$ref: '#/components/responses/CartResponse'
summary: Add Cart Line Items
operationId: addCartLineItem
operationId: addCartLineItems
'/carts/{cartId}/redirect_urls':
parameters:
- $ref: '#/components/parameters/cartId'
Expand Down Expand Up @@ -554,7 +554,7 @@ paths:
'404':
description: Cart not found.
summary: Get a Cart
operationId: getACart
operationId: getCart
put:
description: |-
Updates a *Cartʼs* `customer_id`.
Expand Down Expand Up @@ -592,7 +592,7 @@ paths:
'201':
$ref: '#/components/responses/CartResponse'
summary: Update Customer ID
operationId: updateACart
operationId: updateCart
delete:
description: Deletes a *Cart*. Once a *Cart* has been deleted it can’t be recovered.
tags:
Expand All @@ -601,7 +601,7 @@ paths:
'204':
description: ''
summary: Delete a Cart
operationId: deleteACart
operationId: deleteCart
'/carts/settings':
parameters:
- $ref: '#/components/parameters/Accept'
Expand Down Expand Up @@ -812,7 +812,7 @@ paths:
Create a cart `Metafield`.

If you create an order from a Cart, you can continue referencing the Cart Metafields even if you delete the original Cart. Use the `cart_id` field on the Order to construct the Cart Metafield endpoint.
operationId: CreateCartMetafieldsByCartId
operationId: createCartMetafield
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
Expand Down Expand Up @@ -851,7 +851,7 @@ paths:
tags:
- Metafields
description: Gets a cart metafield.
operationId: getACartMetafield
operationId: getCartMetafield
responses:
'200':
description: |
Expand Down Expand Up @@ -888,7 +888,7 @@ paths:
- Metafields
description: |
Update a `Metafield`, by `cart_id`.
operationId: UpdateCartMetafieldsByCartId
operationId: updateCartMetafield
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
Expand Down Expand Up @@ -928,7 +928,7 @@ paths:
- Metafields
description: |
Deletes a `Metafield`.
operationId: deleteCartMetafieldById
operationId: deleteCartMetafield
responses:
'204':
description: |
Expand Down
8 changes: 4 additions & 4 deletions reference/catalog/brands_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ paths:
- Brands
summary: Delete a Brand
description: Deletes a *Brand*.
operationId: deleteBrandById
operationId: deleteBrand
responses:
'204':
description: ''
Expand All @@ -978,7 +978,7 @@ paths:
- Metafields
summary: Get All Brand Metafields
description: 'Returns a list of *Brand Metafields*. Optional filter parameters can be passed in. '
operationId: getBrandMetafieldsByBrandId
operationId: getBrandMetafields
parameters:
- name: id
in: query
Expand Down Expand Up @@ -1279,7 +1279,7 @@ paths:
- Metafields
summary: Get a Brand Metafields
description: Returns a *Brand Metafield*. Optional filter parameters can be passed in.
operationId: getBrandMetafieldByBrandId
operationId: getBrandMetafield
parameters:
- name: metafield_id
in: path
Expand Down Expand Up @@ -1434,7 +1434,7 @@ paths:
- Metafields
summary: Delete a Brand Metafield
description: Deletes a *Brand Metafield*.
operationId: deleteBrandMetafieldById
operationId: deleteBrandMetafield
parameters:
- name: metafield_id
in: path
Expand Down
14 changes: 7 additions & 7 deletions reference/catalog/categories_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ paths:
- Categories
summary: Get a Category
description: Returns a single *Category*. Optional parameters can be passed in.
operationId: getCategoryById
operationId: getCategory
parameters:
- name: include_fields
in: query
Expand Down Expand Up @@ -1140,7 +1140,7 @@ paths:
- Categories
summary: Delete a Category
description: Deletes a *Category*.
operationId: deleteCategoryById
operationId: deleteCategory
responses:
'204':
description: ''
Expand All @@ -1154,7 +1154,7 @@ paths:
- Metafields
summary: Get All Category Metafields
description: Returns a list of *Metafields* on a *Category*. Optional filter parameters can be passed in.
operationId: getCategoryMetafieldsByCategoryId
operationId: getCategoryMetafields
parameters:
- name: id
in: query
Expand Down Expand Up @@ -1422,7 +1422,7 @@ paths:
- Metafields
summary: Get a Category Metafield
description: Returns a single *Category Metafield*. Optional parameters can be passed in.
operationId: getCategoryMetafieldByCategoryId
operationId: getCategoryMetafield
parameters:
- name: include_fields
in: query
Expand Down Expand Up @@ -1547,7 +1547,7 @@ paths:
- Metafields
summary: Delete a Category Metafield
description: Deletes a *Category Metafield*.
operationId: deleteCategoryMetafieldById
operationId: deleteCategoryMetafield
responses:
'204':
description: ''
Expand Down Expand Up @@ -1684,7 +1684,7 @@ paths:
- Priority 1: Manually specified sort order on Category Level (API).
- Priority 2: Manually specified sort order on Product (Global) Level (UI/API).
- Priority 3: Default sorting by Product ID (newly added products go first) (UI/API).
operationId: getsortorders
operationId: getCategorySortOrders
responses:
'200':
description: ''
Expand All @@ -1710,7 +1710,7 @@ paths:
- Sort Order
summary: Update Product Sort Order
description: Updates sort order of products within a specific category.
operationId: updatesortorder
operationId: updateCategorySortOrders
parameters:
- $ref: '#/components/parameters/ContentType'
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion reference/catalog/category-trees_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ paths:
get:
summary: Get a Category Tree
description: Returns a *Category Tree*.
operationId: GetCategoryTreeByTreeId
operationId: GetCategoryTree
parameters:
- name: depth
description: Max depth for a tree of categories.
Expand Down
Loading
Loading