Skip to content

Commit 59f6e42

Browse files
add openapi diff note
1 parent ac4f4b7 commit 59f6e42

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

develop-docs/backend/api/public.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,8 @@ will be triggered to make your changes automatically go live:
412412

413413
## Troubleshooting API Docs Tests
414414

415+
NOTE: The `openapi-diff` test is supposed to fail when CI runs on your pull request as it is meant to highlight the schema changes. It is not required to merge.
416+
415417
**Problem**: `TypeError: Cannot read properties of null (reading 'type')`
416418

417419
**Solution**: If you have a `ChoiceField` that can be null, make sure you're using the right option. `allow_blank` should be used for textual choices, while `allow_null` should be used for numeric and other non-textual choices.

0 commit comments

Comments
 (0)