diff --git a/README.md b/README.md index 38e665e..dbe7db9 100644 --- a/README.md +++ b/README.md @@ -37,13 +37,13 @@ The API Publisher has three options to use the product. The API Publisher requi #### Option 1 - From binaries - 1. Download the latest published API Publisher package here: [Ed-Fi API Publisher v1.0](https://dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_artifacts/feed/EdFi/NuGet/EdFi.ApiPublisher/overview/1.1.0). Visit the page and click download. - 2. This will download a NuGet package to your computer. Rename this file, `EdFi.ApiPublisher.1.1.0.nupkg`, to include .zip extension: `EdFi.ApiPublisher.1.1.0.zip`. + 1. Download the latest published API Publisher package here: [Ed-Fi API Publisher v1.2](https://dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_artifacts/feed/EdFi/NuGet/EdFi.ApiPublisher/overview/1.2.0). Visit the page and click download. + 2. This will download a NuGet package to your computer. Rename this file, `EdFi.ApiPublisher.1.2.0.nupkg`, to include .zip extension: `EdFi.ApiPublisher.1.2.0.zip`. 3. The binary mentioned below is in the `EdFi.ApiPublisher.Win64` folder, as `EdFiApiPublisher.exe`. #### Option 2 - From Docker images -The Docker image for the Ed-Fi API Publisher is available here: [Ed-Fi API Publisher v1.0 on Docker Hub](https://hub.docker.com/layers/edfialliance/ods-api-publisher/v1.1.0/images/sha256-4930ca34fbc71dee2fbbec09c904f980d86db536e0486f713fd03341ea5854d5?context=explore). Use this to include in your Docker environment and alongside other components of the Ed-Fi stack. +The Docker image for the Ed-Fi API Publisher is available here: [Ed-Fi API Publisher tag v1.2 on Docker Hub](https://hub.docker.com/r/edfialliance/ods-api-publisher/tags). Use this to include in your Docker environment and alongside other components of the Ed-Fi stack. #### Option 3 - Build the API Publisher from source code @@ -95,7 +95,7 @@ For more information in relation to key changes and deletes, please see [Conside ## Known Limitations for Ed-Fi ODS / API 5.1 through 5.3 -Currently, Ed-Fi ODS / API 5.1 through 5.3 has the following known issues related to Change Queries and the Ed-Fi API Publisher. These have been resolved in [Ed-Fi ODS / API 5.3-cqe patch](https://techdocs.ed-fi.org/display/EFTD/Change+Query+Enhancements) and [Ed-Fi ODS / API 6.1](https://techdocs.ed-fi.org/pages/viewpage.action?pageId=138642238). +Currently, Ed-Fi ODS / API 5.1 through 5.3 has the following known issues related to Change Queries and the Ed-Fi API Publisher. These have been resolved in [Ed-Fi ODS / API 5.3-cqe patch](https://edfi.atlassian.net/wiki/spaces/EFTD/pages/24807016/Change+Query+Enhancements) and [Ed-Fi ODS / API 6.1](https://edfi.atlassian.net/wiki/spaces/ODSAPIS3V61/overview). * [Change Queries implementation doesn't provide enough information to communicate deletes between ODS databases](https://tracker.ed-fi.org/browse/ODS-3672) * [Add support to Change Queries for tracking deletes by natural key](https://tracker.ed-fi.org/browse/ODS-4423) @@ -131,7 +131,7 @@ For support with the API Publisher, please use [Ed-Fi Support](https://support.e ## Legal Information -Copyright (c) 2023 Ed-Fi Alliance, LLC and contributors. +Copyright (c) 2024 Ed-Fi Alliance, LLC and contributors. Licensed under the [Apache License, Version 2.0](LICENSE) (the "License"). diff --git a/docs/API-Publisher-Configuration.md b/docs/API-Publisher-Configuration.md index c481b37..5623a7c 100644 --- a/docs/API-Publisher-Configuration.md +++ b/docs/API-Publisher-Configuration.md @@ -30,6 +30,7 @@ Defines general behavior of the Ed-Fi API Publisher. | Options:RateLimitNumberExecutions
`--rateLimitNumberExecutions` | Indicates the maximum number of executions allowed within the defined time window.
(_Default value: 30_) | | Options:RateLimitTimeSeconds
`--rateLimitTimeSeconds` | Indicates the the time span for the rate limit in seconds.
(_Default value: 1_) | | Options:RateLimitMaxRetries
`--rateLimitMaxRetries` | Indicates the number of times the Ed-Fi API publisher will attempt to _resend_ a request, rejected by rate limiting, to the source or destination APIs before determining that the failure is permanent.
(_Default value: 10_) | +| Options:useReversePaging
`--useReversePaging` | Indicates whether or not to use reverse paging mode. For more information about this feature read [here](Reverse-Paging.md).
(_Default value: false_) | ## API Connections diff --git a/src/Dockerfile b/src/Dockerfile index 7e15b33..2bc7187 100644 --- a/src/Dockerfile +++ b/src/Dockerfile @@ -33,3 +33,4 @@ RUN apk --no-cache add unzip=~6 dos2unix=~7 bash=~5 gettext=~0 postgresql13-clie rm -f /app/*.exe ENTRYPOINT [ "/app/run.sh" ] +