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

Described API URLs do not match auto-generated schema #11854

Open
whitep4nth3r opened this issue Nov 18, 2024 · 2 comments
Open

Described API URLs do not match auto-generated schema #11854

whitep4nth3r opened this issue Nov 18, 2024 · 2 comments

Comments

@whitep4nth3r
Copy link
Contributor

SDK

Other

Description

Relevant Discord thread: https://discord.com/channels/621778831602221064/1301836198355931220/1301836198355931220

Affected pages:

API URLs described at the top of API pages including (but not limited to):

The issue

URLs, e.g. GET /api/0/issues/{issue_id}/ are used as an example of a URL to call.

Further down on the page, the docs state that each URL requires an organization_id_or_slug.

This is not represented in the URL.


I understand that the API docs are auto-generated from the annotations on API endpoint definitions inside the Sentry repo i.e. here.

Suggested Solution

No response

@getsantry
Copy link
Contributor

getsantry bot commented Nov 18, 2024

Assigning to @getsentry/support for routing ⏲️

@a-hariti
Copy link
Collaborator

I think this has to do with auto generated API docs more than authors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Waiting for: Support
Development

No branches or pull requests

2 participants