Skip to content

Commit 7aad160

Browse files
committed
🔧 chore: add additional troubleshooting instructions
1 parent 9ee8b7e commit 7aad160

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

develop-docs/backend/api/public.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,28 @@ NOTE: The `openapi-diff` test is supposed to fail when CI runs on your pull requ
481481

482482
**Solution**: You need to add the endpoint to a [sidebar tab](/backend/api/public/#3-sidebar-tab) with the decorator `@extend_schema(tags=['<section title>'])`.
483483

484+
**Problem**: `drf_spectacular.plumbing.UnableToProceedError' <class 'serializer_parth.FooSerializer'> ... raise UnableToProceedError(hint)`
485+
486+
**Solution**: Check that the response of your API documentation is using a TypedDict rather than a serializer.
487+
488+
If the scheme looks something like this:
489+
```python
490+
...
491+
200: inline_sentry_response_serializer(
492+
"ListDocIntegrationResponse", list[FooSerializer]
493+
),
494+
```
495+
496+
Then you need to change it to use a TypedDict by first typing the serializer, then updating the schema to use the TypedDict:
497+
```python
498+
...
499+
200: inline_sentry_response_serializer(
500+
"ListDocIntegrationResponse", list[FooSerializerResponse]
501+
),
502+
```
503+
504+
Refer to the section above on [Success Responses](#success-responses) for more information.
505+
484506
---
485507

486508
## Requesting an API to be public

0 commit comments

Comments
 (0)