openedx
docs: instructor ORA api spec
Description
Resolves:
- https://github.com/openedx/edx-platform/issues/37752
- https://github.com/openedx/edx-platform/issues/37753
This PR introduces architectural decision records (ADRs) and an OpenAPI specification for the modernized Instructor Dashboard v2 API, specifically for the Open Response Assessment (ORA) section.
These documentation artifacts define the design rationale, RESTful endpoint structure, and technical contracts that will guide the v2 ORA API implementation as part of the Instructor Dashboard MFE migration.
Changes
-
ADR for Open Response Assessment API (
0003-ora-api-spec.rst)
Defines the proposed RESTful endpoints and key architectural decisions. -
OpenAPI specification for ORA endpoints (
instructor-v2-ora-api-spec.yaml)
Documents the proposed v2 ORA endpoints, request/response schemas, authentication, and error formats.
