...
- General
- The Trichotomy
- Lifecycle
- Design
- Incubation
- Formalization
- Evolution
- Deprecation
- (how do we discover that something is no longer used?)
- Support model
- REST APIs
- Substantive existing writeup is at Open edX REST API Conventions.
- Versioning
- Pagination (in-progress by Dave O)
- Security
- Naming
- Parameters
- Multi-site
- SLAs and performance goals
- language-headers
- Errors (reasonable 4xx and 5xx returns should be happening for each endpoint; useful localizable strings should return as error messages)
- Python APIs
- (what do we need here?)
- See Python API ADR for edx-platform
- Versioning
- Mock objects for django plugin apps – separate repo?
- Naming conventions
- Base functionality requirements: pull from existing plugins (e.g., openedx-completion-aggregator compat, eox-core edxapp_wrapper)
...
- Sample implementations of Coding Conventions best practices
- Documentation tooling
- Best-practice linters
- Testing infrastructure
- API Clients (edx-rest-api-client, edx-api-client, can also be autogenerated)
Specific Implementations
Implementation work on specific APIs
...