Skip to content

Add build info API to doc #5227

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

Merged

Conversation

alvinlin123
Copy link
Contributor

@alvinlin123 alvinlin123 commented Mar 23, 2023

What this PR does:
Because we are going to release v1.15.0 soon, we should update the API doc with new API.

I also introduced a column called "available since" as a way to allow API doc to be updated at the same time as code change. I will find some time to backfill the "available since" column for other APIs.

Which issue(s) this PR fixes:
Fixes #4984

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@alvinlin123 alvinlin123 force-pushed the update-api-doc-for-build-info branch from 713d277 to 57d0f45 Compare March 23, 2023 22:02
Signed-off-by: Alvin Lin <[email protected]>
@alvinlin123 alvinlin123 merged commit 18ef50b into cortexproject:master Mar 23, 2023
alexqyle pushed a commit to alexqyle/cortex that referenced this pull request May 2, 2023
* Add build info API to documentataion

Signed-off-by: Alvin Lin <[email protected]>

* remove trailing space

Signed-off-by: Alvin Lin <[email protected]>

---------

Signed-off-by: Alvin Lin <[email protected]>
Signed-off-by: Alex Le <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API doc for /api/v1/status/buildinfo when releasing 1.15.0
2 participants