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

🔧 chore(api): add additional troubleshooting instructions to publish api docs #11772

Merged
merged 3 commits into from
Nov 8, 2024
Merged

🔧 chore(api): add additional troubleshooting instructions to publish api docs #11772

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7aad160
:wrench: chore: add additional troubleshooting instructions
iamrajjoshi Nov 8, 2024
3ab6642
Update develop-docs/backend/api/public.mdx
iamrajjoshi Nov 8, 2024
65b1992
Apply suggestions from code review
iamrajjoshi Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions develop-docs/backend/api/public.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,30 @@ NOTE: The `openapi-diff` test is supposed to fail when CI runs on your pull requ

iamrajjoshi marked this conversation as resolved.
Show resolved Hide resolved
---

**Problem**: `drf_spectacular.plumbing.UnableToProceedError' <class 'serializer_path.FooSerializer'> ... raise UnableToProceedError(hint)`

**Solution**: Check that the response of your API documentation is using a TypedDict rather than a serializer.

If the schema looks something like this:
```python
...
200: inline_sentry_response_serializer(
"ListDocIntegrationResponse", list[FooSerializer]
),
```

Then you need to change it to use a TypedDict by first typing the serializer, then updating the schema to use the TypedDict:
```python
...
200: inline_sentry_response_serializer(
"ListDocIntegrationResponse", list[FooSerializerResponse]
),
```

Refer to the section above on [Success Responses](#success-responses) for more information.

---

## Requesting an API to be public

Are you a Sentry user who wants an endpoint to be public?
Expand Down
Loading