Skip to content

DEVDOCS-6413 Improve readability of modifier information in "Catalog … #989

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

bc-Vince
Copy link
Contributor

@bc-Vince bc-Vince commented Jun 27, 2025

…- Product modifiers"

Added intro sections to provide detailed information on theoption_values array and the config object.

Added intro section with detailed information on supported file types for file upload modifiers.

Updated request and response bodies of endpoints to reference the new intro sections instead of having bulky descriptions.

DEVDOCS-6413

What changed?

  • The introduction now has sections that go into detail about modifier option values, configs and supported file types.
  • Relevant request and response fields now reference the new sections instead of including bulk information in their descriptions.

Release notes draft

  • Added descriptive information on type-specific fields for modifier option values and configs.
  • Added a table with information on supported file types for the file upload modifier type.

Anything else?

ping @bc-terra

…- Product modifiers"

Added intro sections to provide detailed information on theoption_values array and the config object.

Added intro section with detailed information on supported file types for file upload modifiers.

Updated request and response bodies of endpoints to reference the new intro sections instead of having bulky descriptions.
@bc-Vince bc-Vince requested a review from bc-terra June 27, 2025 15:14
@bc-Vince bc-Vince requested a review from a team as a code owner June 27, 2025 15:14
@bc-Vince bc-Vince added the ready for review This PR is complete and awaiting a review. label Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for review This PR is complete and awaiting a review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant