Skip to content

[FC-0118] Add ADRs for technical Recommendations on Open edX REST API Standards #38137

@Faraz32123

Description

@Faraz32123

The purpose of creating this issue is that in the end we have a finalized set of ADRs on Open edX REST API Standards that can be followed for APIs development.
The intent will not be to redesign the entire platform or introduce breaking changes unnecessarily, but to establish clear, shared patterns for how APIs should be built going forward, while gradually improving existing endpoints. By aligning more closely with the Django REST Framework (DRF) and widely accepted REST and OpenAPI best practices, the platform can offer a more consistent and reliable API experience. In addition, it will lower integration costs for external systems, make API reusable and provide a stronger foundation for future growth.

The ADRs should include standardizing:

  • serializer usage
  • permission enforcement
  • documentation and schema coverage
  • endpoint structure
  • error responses
  • pagination
  • versioning
  • the migration of legacy Django views to DRF

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions