Add code-derived OpenAPI 3.0 spec for Supermarket API v1#3393
Draft
Copilot wants to merge 1 commit into
Draft
Conversation
Agent-Logs-Url: https://github.com/chef/supermarket/sessions/649e26e0-897b-41ce-b2ef-af2411c5a347 Co-authored-by: brianLoomis <90281862+brianLoomis@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
brianLoomis
May 13, 2026 03:21
View session
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.
This PR adds an accurate OpenAPI specification for Chef Supermarket’s API surface based on current routes/controllers/views, replacing drift-prone interpretation with code-aligned contract documentation. The spec captures implemented behavior, including aliases, auth expectations, payload shapes, and known legacy endpoints.
Scope captured (API surface)
/api/v1plus route aliases (/universe,/api/v1/universe,/status).Contract details encoded
start,items,order,platforms[],version, etc.) and documented constraints/defaults.302withLocation).Auth and feature behavior
fieri_key-guarded quality-metric endpoints.Artifact added
src/supermarket/docs/supermarket-api-v1.openapi.yaml