docs: create schema for enrollment api

[wgu-jesse-stewart]

Issue: 37814

Description

docs: Add ADR and OpenAPI specification for Instructor Enrollment API This PR adds an architectural decision record (ADR) and OpenAPI specification for the Instructor Dashboard Enrollment API endpoints. These documentation files provide the design rationale and technical contract for the v2 enrollment API implementation, following Open edX REST API Conventions.

Changes

• ADR for Enrollment API (0003-instructor-enrollment-api-spec.rst) - documents RESTful enrollment management design with sync/async execution models, pagination, optional fields, and enrollment state handling
• OpenAPI spec for Enrollment endpoints (instructor-v2-enrollment-api-spec.yaml) - specification for enrollment operations including list, enroll, get details, and unenroll endpoints.

Supporting information

Related to the Instructor Dashboard modernization effort. These documents establish the foundation for migrating enrollment management functionality from legacy endpoints (lms/djangoapps/instructor/enrollment.py) to RESTful patterns supporting MFE development. The design follows Open edX REST API Conventions including:

• Resource-oriented URLs with proper HTTP verbs (GET, POST, DELETE)
• Sync/async execution model (single learner vs multiple learners)
• DRF standard pagination format
• requested_fields parameter for optional fields (beta_tester, profile_image)
• Dual authentication support (OAuth2 + Session-based)
• ISO 8601 date/time serialization
• Structured error responses with error_code, developer_message, user_message, and field_errors

[openedx-webhooks]

Thanks for the pull request, @wgu-jesse-stewart!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[Copilot]

Pull request overview

This PR adds comprehensive documentation for the Instructor Dashboard Enrollment API v2, establishing the design foundation for migrating enrollment management functionality from legacy endpoints to RESTful patterns that support MFE development.

Key changes:

• Documents RESTful API design with sync/async execution models based on operation scope
• Specifies pagination, optional fields, authentication, error handling, and email notification patterns
• Establishes OpenAPI specification as implementation reference (to be deleted after deployment)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
lms/djangoapps/instructor/docs/references/instructor-v2-enrollment-api-spec.yaml	Complete OpenAPI 2.0 specification defining enrollment endpoints, request/response schemas, authentication, and error handling
lms/djangoapps/instructor/docs/decisions/0003-instructor-enrollment-api-spec.rst	ADR documenting design decisions including RESTful patterns, sync/async execution model, pagination strategy, and alternatives considered

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[brianjbuck-wgu]

I read through this and didn't see anything glaring.