Skip to content
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

Phil/cp api updates #1842

Merged
merged 3 commits into from
Dec 18, 2024
Merged

Phil/cp api updates #1842

merged 3 commits into from
Dec 18, 2024

Conversation

psFried
Copy link
Member

@psFried psFried commented Dec 18, 2024

Rolls up a couple of updates:

  • removes pending migrations dir: Slack link explaining why these pending migrations should be deleted
  • Adds a bunch of doc comments, so that they appear as descriptions in the openapi spec. As of now, all fields appearing the public api have comments (unless I missed some lol)
  • Changes the status endpoint path from /api/v1/status to /api/v1/catalog/status because I realized it was a mistake to not have any sort of type prefix (perhaps we want a data plane status endpoint too?) and this is not yet released so there's no risk of breaking anything if I fix it now

This change is Reviewable

These two migrations were only ever checked in in order to get reviewed before
running them on prod. Neither should be applied to local stacks.
Adds comments to all the publications fields, which get rendered as
descriptions in the json schemas.
@psFried psFried requested a review from jshearer December 18, 2024 20:01
I realized that I violated a basic rule of api design by not having any sort of
type prefix in the path. This hasn't been released yet, so there's no risk of
breaking anything important if we change it now.
Copy link
Contributor

@jshearer jshearer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@psFried psFried merged commit 017b707 into master Dec 18, 2024
4 checks passed
@psFried psFried deleted the phil/cp-api-updates branch December 18, 2024 22:11
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