THIS PAGE IS DEV-PROTECTED UNTIL API PUBLISHER 1.0 RELEASE
| Note | ||||
|---|---|---|---|---|
| ||||
June 2023: On behalf of the Ed-Fi community, we are pleased to announce the release of API Publisher 1.0. For more details see What's New in API Publisher. |
Overview
...
The Ed-Fi API Publisher is a utility that can be used to move data from one Ed-Fi ODS/API instance to another ODS/API instance of the same version (i.e ODS/API 6.1 → ODS/API 6.1). It operates as a standard API client against both API endpoints (source and target) and thus it does not require any special network configuration, direct ODS database access or a particular database engine. From a data security/privacy perspective, it is also subject to all authorization performed by the Ed-Fi ODS API endpoints with which it communicates.
The primary user groups for API Publisher are:
- (TODO: PO to add more information on user groups/cases for API Publisher)States and district collaboratives staff using Ed-Fi
- IT administrators responsible for Ed-Fi ODS/API platforms
Primary features of API Publisher includes:
- (TODO: PO to add more information on primary features for API Publisher)
...
- Publishing, or copying, data between Ed-Fi
...
- ODS/API instances of the same version
- Retry support for failed records
- Remediation scripting support to attempt to fix re-occurring data publishing errors using Node.Js
- Ed-Fi extension support including Education Preparation Programs
- Change queries, which will allow only changed data to be copied in subsequent runs
Release Information
...
The Ed-Fi API Publisher is currently at version v1.0. Below are links to access the binary package and the Docker container for API Publisher:
Binary Package
- (TODO: description and link here upon release)
Docker Hub
- (TODO: description and link here upon release)https://dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_artifacts/feed/EdFi/NuGet/EdFi.ApiPublisher/overview/1.0.0
Docker Hub
- The latest release of API Publisher is v1.0.0:
Documentation
...
Documentation for the API Publisher is available online at GitHub via the following links:
- Developer Documentation
- README.md - A technical overview of Ed-Fi API Publisher with quick start instructions.
- API-Connection-Management.md - Reference for using Configuration Stores with Ed-Fi API Publisher
- Aws-Parameter-Store.md - Details for using AWS Parameter Store as the Configuration Store
- PostgreSql.md - Details for using Postgres as the Configuration Store
- Sql-Server.md - Details for using SQL Server as the Configuration Store
- API-Publisher-Configuration.md - Reference for API Publisher's configuration with details for each option
- Considerations-for-API-Hosts.md - Considerations for Ed-Fi API hosts and incorporating into production workflows
- Extensibility.md - Developer notes for extensions and modifications.
- Known-Issues-Details.md - Known issues with full details
- Remediations.md - Information on using remediation scripts for failed POSTs
- Other Items
- CONTRIBUTORS.md - A listing of contributors to the open-source Ed-Fi API Publisher product.
- LICENSE - The Apache 2.0 license, as applies to the Ed-Fi API Publisher.
- NOTICES.md - A listing of copyright notices for the Ed-Fi API Publisher and libraries in use.
...