Skip to content

feat: Add OpenAPI docs for monitor endpoints#42850

Merged
dcramer merged 1 commit intomasterfrom
feat/document-monitors-api
Jan 6, 2023
Merged

feat: Add OpenAPI docs for monitor endpoints#42850
dcramer merged 1 commit intomasterfrom
feat/document-monitors-api

Conversation

@dcramer
Copy link
Copy Markdown
Member

@dcramer dcramer commented Jan 5, 2023 •
edited
Loading

Refs #42283

@dcramer dcramer requested a review from a team as a code owner January 5, 2023 21:33
@dcramer
Copy link
Copy Markdown
Member Author

dcramer commented Jan 5, 2023

Need to make sure these do what are expected, and ideally label them as "Beta" somehow.

@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Jan 5, 2023
JoshFerge
JoshFerge reviewed Jan 5, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@JoshFerge JoshFerge left a comment

Choose a reason for hiding this comment

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

think the endpoints have to be removed from src/sentry/apidocs/public_exclusion_list.py for the schema to be generated (grandfathered endpoints before api docs schema changes).

@dcramer dcramer force-pushed the feat/document-monitors-api branch from 120b86c to 53cfef0 Compare January 5, 2023 21:47
@vercel
Copy link
Copy Markdown

vercel bot commented Jan 5, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
storybook 🔄 Building (Inspect) Jan 6, 2023 at 4:44PM (UTC)

@dcramer dcramer force-pushed the feat/document-monitors-api branch 2 times, most recently from 48f6c4b to 0250f8b Compare January 5, 2023 22:14
@dcramer
Copy link
Copy Markdown
Member Author

dcramer commented Jan 5, 2023

Only thing that is blocking ATM is to determine how to undocument one of the two endpoints (e.g. the one without the organization prefix URL).

@dcramer dcramer force-pushed the feat/document-monitors-api branch from 0250f8b to 6923220 Compare January 5, 2023 22:32
@dcramer dcramer force-pushed the feat/document-monitors-api branch from 6923220 to 28b3279 Compare January 5, 2023 22:44
@dcramer
Copy link
Copy Markdown
Member Author

dcramer commented Jan 5, 2023

Done and done. Lets wait to merge til #42825 is in.

@dcramer
Copy link
Copy Markdown
Member Author

dcramer commented Jan 5, 2023

I THINK the failed check is what we'd expect, but someone from ecosystem could confirm? Its just showing the newly added schema/sidebar thing. I didn't build these against the prod API, but I can try to do that locally (tests wouldnt work for me due to some DB errors)

markstory
markstory reviewed Jan 6, 2023
View reviewed changes
@dcramer dcramer force-pushed the feat/document-monitors-api branch from 28b3279 to 95273ae Compare January 6, 2023 16:44
@dcramer
Copy link
Copy Markdown
Member Author

dcramer commented Jan 6, 2023

Alright gonna ship it and see what breaks.

@dcramer dcramer force-pushed the feat/document-monitors-api branch from d89163c to 52ab31e Compare January 6, 2023 17:19
@dcramer dcramer force-pushed the feat/document-monitors-api branch from 52ab31e to 87915fa Compare January 6, 2023 17:20
@dcramer dcramer enabled auto-merge (squash) January 6, 2023 17:24
@dcramer dcramer merged commit 37c3ee8 into master Jan 6, 2023
@dcramer dcramer deleted the feat/document-monitors-api branch January 6, 2023 17:40
@dcramer dcramer mentioned this pull request Jan 6, 2023
Merged
dcramer added a commit that referenced this pull request Jan 6, 2023
@dcramer
fix: Correct API usage for Crons (#42886)
8634c54 
- Remove legacy docstrings and replace with better descriptions
- Missing checkin details endpoint for Hybrid Cloud

Refs #42850
@github-actions github-actions bot locked and limited conversation to collaborators Jan 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@markstory markstory markstory left review comments

@JoshFerge JoshFerge JoshFerge left review comments

+1 more reviewer

@davidenwang davidenwang davidenwang approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dcramer @markstory @JoshFerge @davidenwang