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.

Sign up for GitHub

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

Jump to bottom

add public documentation for organizations and teams public API endpoints #2448

Closed
joeyorlando opened this issue Jul 6, 2023 · 2 comments · Fixed by #4815
Closed

add public documentation for organizations and teams public API endpoints #2448

joeyorlando opened this issue Jul 6, 2023 · 2 comments · Fixed by #4815
Assignees
@alyssawada @JohnnyK-Grafana
Labels
part:API type/docs Grafana Labs internal. Docs Squad label across all Grafana Labs repos

Comments

@joeyorlando
Copy link
Contributor

What would you like to see!

In the public API docs we're missing docs for the /teams endpoints. We should document these.

Product Area

Other

Anything else to add?

No response
@joeyorlando joeyorlando added the feature request New feature or request label Jul 6, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 6, 2023

The current version of Grafana OnCall, at the time this issue was opened, is v1.3.6. If your issue pertains to an older version of Grafana OnCall, please be sure to list it in the PR description. Thank you 😄!

@joeyorlando joeyorlando changed the title add public documentation for teams public API endpoints add public documentation for organizations and teams public API endpoints Jul 10, 2023
@joeyorlando
Copy link
Contributor Author

We had a support engineer come to use with a question related to these endpoints. A customer had a use case where they essentially needed to fetch OnCall teams data (in specific the OnCall ID for a team). These endpoints exist but they're not documented.

@Matvey-Kuk Matvey-Kuk added the type/docs Grafana Labs internal. Docs Squad label across all Grafana Labs repos label Jul 17, 2023
@joeyorlando joeyorlando mentioned this issue Jun 14, 2024
Closed
@joeyorlando joeyorlando mentioned this issue Jun 14, 2024
Closed
@joeyorlando joeyorlando mentioned this issue Aug 15, 2024
Merged
3 tasks
github-merge-queue bot pushed a commit that referenced this issue Aug 15, 2024
@joeyorlando
add POST /escalation public API endpoint + add public API docs for …
67fc52d 
…teams/organization endpoints (#4815)

# What this PR does

- Adds a `POST /escalation` public endpoint (equivalent to the internal
direct paging API endpoint)
- Adds public API documentation for teams and organization endpoints

<img width="1140" alt="Screenshot 2024-08-15 at 12 49 40"
src="https://github.com/user-attachments/assets/e0e8d6bb-f3ac-4f9e-bdf7-e8926949cc3b">

## Which issue(s) this PR closes

Closes grafana/oncall-private#2859
Closes #2448

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] Added the relevant release notes label (see labels prefixed w/
`release:`). These labels dictate how your PR will
    show up in the autogenerated release notes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alyssawada alyssawada

@JohnnyK-Grafana JohnnyK-Grafana

Labels
part:API type/docs Grafana Labs internal. Docs Squad label across all Grafana Labs repos
Projects
None yet
Milestone
No milestone
5 participants
@iskhakov @Matvey-Kuk @joeyorlando @alyssawada @JohnnyK-Grafana