In support of a strategic goal of moving the Ed-Fi Alliance technical suite to an "API-first" development model:
- Migrate the following content from Ed-Fi Tech Docs to a GitHub repository:
- API Design Guidelines
- Official (Open API) specifications
- RFCs
- Produce revision 4.0 of the Ed-Fi API Guidelines.
- Revise domain-specific RFCs and API guidance (e.g. dealing with the Survey API).
Tip
What do we mean by "API-first"? In a literal sense, the Ed-Fi Data Standard and its Unifying Data Model (UDM) will continue to drive generation of the API specifications. Historically, the API specification was only available after the Data Standard updates were integrated into the Ed-Fi ODS/API Platform, meaning that feedback on the revised specification could not come until after publishing an update to the ODS/API Platform.
Taking a more API-first approach means publishing proposed specifications before an implementation is available, i.e. before updating the ODS/API Platform. It also means taking greater care to document what it takes for anyone to build an API application and label it as "an Ed-Fi API" or as "Ed-Fi compatible".
Stephen Fuqua, Director of Software Engineering, Ed-Fi Alliance
- Ed-Fi Alliance staff and contractors
- Ed-Fi Alliance Technical Advisory Group (TAG)
- Certified or badged Ed-Fi producers and consumers
- Publication, in this repository, of updated documents.
- TAG approval of proposed revisions.
| # | Status | Description |
|---|---|---|
| 1 | ✅ | Special Interest Group to gather input on revising API Design Guidelines |
| 2 | ✅ | Load existing Guidelines and Data Standard 3.3, 4.0, and 5.0 specs |
| 3 | ✅ | Ed-Fi API Guidelines revision 4.0 - APPROVED BY TAG, MAY 2024 |
| 4 | 📅 | Load existing RFCs, describe governance |
| 5 | 📅 | Action plan for revising RFCs and next steps with Ed-Fi API Guidelines |
| Icon | Meaning |
|---|---|
| ✅ | done |
| 🚧 | in progress |
| 📅 | planned |