Skip to content

Conversation

@maxshhao-topsort
Copy link

@maxshhao-topsort maxshhao-topsort commented Jan 14, 2026

Summary:

Our documentation for qualityScores array inside the products object in payload to engine's /v2/auctions endpoint is not fully aligned with the actual validation. The validation for qualityScores array enforce a non-zero constraint, but the description and range in the docs are not explicit in the fact that a qualityScores array with item(s) as zero will be rejected.
image

Additionally, Mintlify seems to have trouble with rendering the correct range from OpenAPI specs 3.1.0's exclusiveMinimum parameter. To correctly render the range to be exclusive of 0, an additional minimum parameter of 0 need to be added, hence the duplicate minimums in the yml file. This can be removed from once Mintlify fully support the exclusiveMinimum parameter.

Key Changes:

For topsort-api-v2.yml:

  • Refactored description to explicitly describe the non-zero constraint and add better line break support
  • Added a minimum parameter to help range fully reflect the exclusion of 0

Note

Updates OpenAPI spec to align docs with validation for products.qualityScores.

  • Clarifies description to state values must be greater than 0 and less than or equal to 1
  • Adds minimum: 0 while keeping exclusiveMinimum: 0 to aid rendering; retains maximum: 1
  • Cleans up line breaks/formatting in the qualityScores description

Written by Cursor Bugbot for commit daac005. This will update automatically on new commits. Configure here.

@maxshhao-topsort maxshhao-topsort requested a review from a team as a code owner January 14, 2026 07:09
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.

2 participants