diff --git a/develop-docs/backend/api/public.mdx b/develop-docs/backend/api/public.mdx index 0bda5e778bbf1..2100b00a15453 100644 --- a/develop-docs/backend/api/public.mdx +++ b/develop-docs/backend/api/public.mdx @@ -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' ... 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?