Skip to content

CATALOG-9219: [update] Catalog, update all Product Custom Fields endpoints#97

Merged
olysenko merged 3 commits intomainfrom
CATALOG-9219
Feb 19, 2024
Merged

CATALOG-9219: [update] Catalog, update all Product Custom Fields endpoints#97
olysenko merged 3 commits intomainfrom
CATALOG-9219

Conversation

@olysenko
Copy link
Contributor

@olysenko olysenko commented Feb 12, 2024

CATALOG-9219 Review and update public API documentation for the POST|GET|PUT|DELETE v3/catalog/products/:productId/custom-fields

What changed?

  • Updated v3 custom-fields swagger scheme

Release notes draft

  • updated error messaging for custom fields;
  • clarified info about limitation of 250 max allowed characters for the name and value in custom fields.

ping @bigcommerce/team-catalog

@olysenko olysenko requested a review from markcmurphy February 12, 2024 09:40
@slsriehl slsriehl requested review from bc-traciporter and slsriehl and removed request for markcmurphy February 12, 2024 17:10
@slsriehl slsriehl changed the title docs(catalog): CATALOG-9219 Review and update public API documentation for the POST|GET|PUT|DELETE v3/catalog/products/:productId/custom-fields CATALOG-9219: [update] Catalog, update all Product Custom Fields endpoints Feb 12, 2024
@slsriehl
Copy link
Contributor

slsriehl commented Feb 12, 2024

DEVDOCS-5771

Copy link
Contributor

@bc-traciporter bc-traciporter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left editorial suggestions. I mainly tried to remove passive voice. Feel free to not accept my suggestion if the change does not convey the correct meaning.

Copy link
Contributor

@bc-traciporter bc-traciporter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few suggestions

slsriehl pushed a commit that referenced this pull request Feb 15, 2024
<!-- Ticket number or summary of work -->
# [DEVDOCS-5771] & [CATALOG-9219]

## What changed?
<!-- Provide a bulleted list in the present tense -->
* create archive directory

## 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]. -->
* not needed

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->
* Supports #97

ping @olysenko @bc-traciporter


[DEVDOCS-5771]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5771?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[CATALOG-9219]:
https://bigcommercecloud.atlassian.net/browse/CATALOG-9219?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
bc-traciporter
bc-traciporter previously approved these changes Feb 16, 2024
Copy link
Contributor

@bc-traciporter bc-traciporter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

…n for the POST|GET|PUT|DELETE v3/catalog/products/:productId/custom-fields
…n for the POST|GET|PUT|DELETE v3/catalog/products/:productId/custom-fields
Copy link
Contributor

@bc-traciporter bc-traciporter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@olysenko olysenko merged commit 3501473 into main Feb 19, 2024
@olysenko olysenko deleted the CATALOG-9219 branch February 19, 2024 14:30
bc-tgomez pushed a commit that referenced this pull request Apr 26, 2024
<!-- Ticket number or summary of work -->
# [DEVDOCS-5771] & [CATALOG-9219]

## What changed?
<!-- Provide a bulleted list in the present tense -->
* create archive directory

## 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]. -->
* not needed

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->
* Supports #97

ping @olysenko @bc-traciporter


[DEVDOCS-5771]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5771?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[CATALOG-9219]:
https://bigcommercecloud.atlassian.net/browse/CATALOG-9219?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
bc-tgomez pushed a commit that referenced this pull request Apr 26, 2024
…oints (#97)

<!-- Ticket number or summary of work -->
# CATALOG-9219: [update] Catalog, update all Product Custom Fields endpoints (#97)


## What changed?
* Updated v3 custom-fields swagger scheme

## Release notes draft
* updated error messaging for custom fields;
* clarified info about limitation of 250 max allowed characters for the
name and value in custom fields.


ping @bigcommerce/team-catalog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants