Skip to content

Commit 2e2ebb9

Browse files
Faraz32123Muhammad Faraz  Maqsood
andauthored
docs: explicitly mention API versioning incase of backwards incompatible change (#38188)
Co-authored-by: Muhammad Faraz Maqsood <faraz.maqsood@A006-01130.local>
1 parent 87f3155 commit 2e2ebb9

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/decisions/0025-standardize-serializer-usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Implementation requirements:
2222
* Replace manual JSON construction with serializer-based responses.
2323
* Use serializers for both input validation and output formatting.
2424
* Ensure serializers are properly documented with field descriptions and validation rules.
25-
* Maintain backward compatibility for all APIs during migration.
25+
* Maintain backward compatibility for all APIs during migration. While the goal is fully compatible DRF serializers, if that is not possible and we must make a backwards incompatible change, that change MUST be handled by creating a new version of the API and transitioning to that API using the deprecation process.
2626

2727
Relevance in edx-platform
2828
-------------------------

0 commit comments

Comments
 (0)