Skip to content

Conversation

@jbergstroem
Copy link
Contributor

@jbergstroem jbergstroem commented Aug 7, 2025

Lots of improvements to our openapi spec.

  • Updates to OpenAPI 3.1
  • Fixes issues related to upgrade (examples, minimumExample)
  • Add reusable refs for opaqueUserID, resolvedBidID, occuredAt, id
  • Fix issues in cyclic references
  • Fix issues with incorrect examples
  • add yamllint
  • add redocly
  • add vacuum
  • update so yamllint and prettier configs are compatible with each other
  • simplify typos config
  • Rename Components that has a naming conflict with Central Services (Entity, Category)
  • add maxlength to identifiers
  • standardize authentication

So far, fixed around 170 errors.

Todo

This PR can land-as is and forthcoming changes can be added at a later date.

  • incorrect toptimize types
  • make more reusable components such as
    • occuredAt
    • id (marketplace)
  • revert changes to auction example (splitting it up into multiple examples, mintlify only shows the first one)
  • migrate x-examples into real ones
  • fix v1 issues (might just skip it)

@jbergstroem jbergstroem marked this pull request as ready for review August 8, 2025 05:27
@jbergstroem jbergstroem requested a review from celzo August 8, 2025 05:27
These also conflicts with central services
@jbergstroem
Copy link
Contributor Author

I've stiched it all together in this preview branch (requires orchestration here, docs repo, mintlify): https://topsort-chore-new-api-docs-openapi-3-1.mintlify.app/api-reference/auctions/create-auctions

..will add output work in above todo.

@jbergstroem jbergstroem merged commit 872788e into main Aug 11, 2025
6 checks passed
@jbergstroem jbergstroem deleted the feat/openapi-3.1-full-validation branch August 11, 2025 22:20
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