File tree 1 file changed +24
-0
lines changed
1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change @@ -483,6 +483,30 @@ NOTE: The `openapi-diff` test is supposed to fail when CI runs on your pull requ
483
483
484
484
---
485
485
486
+ ** Problem** : ` drf_spectacular.plumbing.UnableToProceedError' <class 'serializer_path.FooSerializer'> ... raise UnableToProceedError(hint) `
487
+
488
+ ** Solution** : Check that the response of your API documentation is using a TypedDict rather than a serializer.
489
+
490
+ If the schema looks something like this:
491
+ ``` python
492
+ ...
493
+ 200 : inline_sentry_response_serializer(
494
+ " ListDocIntegrationResponse" , list[FooSerializer]
495
+ ),
496
+ ```
497
+
498
+ Then you need to change it to use a TypedDict by first typing the serializer, then updating the schema to use the TypedDict:
499
+ ``` python
500
+ ...
501
+ 200 : inline_sentry_response_serializer(
502
+ " ListDocIntegrationResponse" , list[FooSerializerResponse]
503
+ ),
504
+ ```
505
+
506
+ Refer to the section above on [ Success Responses] ( #success-responses ) for more information.
507
+
508
+ ---
509
+
486
510
## Requesting an API to be public
487
511
488
512
Are you a Sentry user who wants an endpoint to be public?
You can’t perform that action at this time.
0 commit comments