Skip to content

Commit

Permalink
🔧 chore(api): add additional troubleshooting instructions to publish …
Browse files Browse the repository at this point in the history
…api docs (#11772)

* 🔧 chore: add additional troubleshooting instructions

* Update develop-docs/backend/api/public.mdx

Co-authored-by: Isabella Enriquez <isabella.enriquez@sentry.io>

* Apply suggestions from code review

Co-authored-by: Isabella Enriquez <isabella.enriquez@sentry.io>

---------

Co-authored-by: Isabella Enriquez <isabella.enriquez@sentry.io>
  • Loading branch information
iamrajjoshi and isabellaenriquez authored Nov 8, 2024
1 parent dd7e55f commit e4a73d6
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions develop-docs/backend/api/public.mdx
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
---
**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

0 comments on commit e4a73d6

Please sign in to comment.