🔧 chore(api): add additional troubleshooting instructions to publish …

…api docs (#11772) * 🔧 chore: add additional troubleshooting instructions * Update develop-docs/backend/api/public.mdx Co-authored-by: Isabella Enriquez <[email protected]> * Apply suggestions from code review Co-authored-by: Isabella Enriquez <[email protected]> --------- Co-authored-by: Isabella Enriquez <[email protected]>
getsentry · Nov 8, 2024 · e4a73d6 · e4a73d6
1 parent dd7e55f
commit e4a73d6
Showing 1 changed file with 24 additions and 0 deletions.
diff --git 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' <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?