[DEVDOCS-5831/PAPI-2091]: Carts v3 and Store information V2, add store-level metafield's open api spec (#197) #199
Conversation
<!-- Ticket number or summary of work --> # [PAPI-2091] ## What changed? - Store metafield's open api spec ## Release notes draft <!-- Provide an entry for the release notes using simple, conversational language. Don't be too technical. Explain how the change will benefit the merchant and link to the feature. Examples: * The newly-released [X feature] is now available to use. Now, you’ll be able to [perform Y action]. * We're happy to announce [X feature], which can help you [perform Y action]. * [X feature] helps you to create [Y response] using the [Z query parameter]. Now, you can deliver [ex, localized shopping experiences for your customers]. * Fixed a bug in the [X endpoint]. Now the [Y field] will appear when you click [Z option]. --> * ## Anything else? <!-- Add related PRs, salient notes, additional ticket numbers, etc. --> ping [PAPI-2091]: https://bigcommercecloud.atlassian.net/browse/PAPI-2091?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Tina Gomez <[email protected]>
bc-tgomez
changed the title
bc-tgomez
added
ready for review
| - Metafields | ||
| description: Gets a store `metafield`. | ||
| operationId: getStoreMetafield | ||
| responses: |
There was a problem hiding this comment.
| responses: | |
| responses: |
Is the response for this endpoint supposed to have a meta object?
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| errors: | ||
| type: array | ||
| description: Empty for 200 responses. | ||
| example: [ ] |
There was a problem hiding this comment.
🚫 [spectral] reported by reviewdog 🐶
type: array must have an items sibling.
| ErrorDetail: | ||
| type: object | ||
| description: | | ||
| Error detail response payload for the BigCommerce API. | ||
| example: | ||
| "1": "Unauthorized to delete" | ||
| "2": "Metafield does not exist" |
There was a problem hiding this comment.
🚫 [spectral] reported by reviewdog 🐶
type: object must have a properties sibling.
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE' | ||
| '/store/metafields/{metafieldId}': |
There was a problem hiding this comment.
There should be no page, limit, key, namespace, direction params for singular get metafield endpoint.
Accept header is not really required, by default it should be application/json :)
There was a problem hiding this comment.
For get endpoint it is impossible to get the 409 :) and I'm not sure even about 422, it is just a GET, there is no input from the API client, also we don't want to document 5XX errors
| - $ref: '#/components/parameters/MetafieldKeyParam' | ||
| - $ref: '#/components/parameters/MetafieldNamespaceParam' | ||
| - $ref: '#/components/parameters/DirectionParam' | ||
| put: |
There was a problem hiding this comment.
Content-TypeandAcceptheaders are optional
There was a problem hiding this comment.
- No pagination for singular endpoint
- 422 status is missing
| status: 404 | ||
| title: There was no metafield found with ID 1010 | ||
| type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' | ||
| delete: |
There was a problem hiding this comment.
Acceptheader is not required- It is possible to have
404status
| '500': | ||
| description: Internal Server Error |
There was a problem hiding this comment.
We decided to don't document 500 errors.
| - $ref: '#/components/parameters/MetafieldNamespaceInParam' | ||
| - $ref: '#/components/parameters/DirectionParam' | ||
| post: | ||
| summary: Create multiple Metafields |
There was a problem hiding this comment.
For store metafields we don't provide resource_id since it is metafields on store level:
For create and update multiple metafields we don't have pagination:
just:
"meta": {
"total": 3,
"success": 1,
"failed": 2
}
Co-authored-by: Sarah Riehl <[email protected]>
PAPI-2091 DEVDOCS-5831
What changed?
Release notes draft
Anything else?
ping @bc-tayvs
[DEVDOCS-]
What changed?
Release notes draft
Anything else?
ping {names}