Update from code changes: document PRODUCT brand type - #110
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document PRODUCT brand type#110mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
PRODUCTvalue on theBrandTypeenum across the Organization Brands API reference and the Brands concept page.Changes
external-api/organization-brands.mdx: listPRODUCTalongsideORGANIZATIONandINDIVIDUAL, add a Brand types section describing each value and noting thatINDIVIDUALandPRODUCTbrands can belong to a brand group whileORGANIZATIONbrands cannot.concepts/brands.mdx: add a Product Brands section, label existing sections with their APItypevalues, and clarify the Corporate + Product multi-brand scenario.Context
Follows chainpatrol/chainpatrol-web#7437, which added
PRODUCTas a thirdBrandTypevalue returned byGET /organization/brandsand accepted by the CLI'sbrands list --typeflag.Note
Low Risk
Documentation-only updates with no runtime or API behavior changes in this repo.
Overview
Documentation now reflects the third
BrandType,PRODUCT, alongsideORGANIZATIONand `INDIVIDUAL.On
concepts/brands.mdx, the types section is expanded with a Product Brands subsection, APItypelabels on company and individual headings, tighter company-brand wording (organization vs product lines), and an updated corporate + product multi-brand example usingtype: PRODUCT.On
external-api/organization-brands.mdx, the overview lists product brands in theGET /organization/brandsresponse and a new Brand types section defines each enum value and notes thatINDIVIDUALandPRODUCTmay usebrandGroupIdwhileORGANIZATIONbrands cannot.Reviewed by Cursor Bugbot for commit 6c6c791. Bugbot is set up for automated code reviews on this repo. Configure here.