v2.3.1-alpha.0.1

[ADMINAPI-1332] Prepare to archive this repository (#389)

Remove scorecard link before archiving this repository
Add a note about moving to the other repository

Ed-Fi ODS Admin API v2.3.0

Features

• Tenant endpoints on V2: new read-only and management endpoints.

• Health check endpoints for Security and Admin databases.

• Integration test coverage enabled for Admin API.

• Updated OpenAPI specifications for v2.3.0.

• Docker images now built and published for ARM processors.

Enhancements

• Improved Dockerfiles and connection string handling.

• Security updates: .NET vulnerabilities remediated, upgraded to .NET 8.0.21.

• Logging improvements: fixed double logging, improved configuration logging.

Installer workflow improvements.

• Claimset import now includes grandchild ResourceClaims.

• Profile endpoint returns clear 400 error for invalid input.

• Improved log4net initialization for cross-platform compatibility.

Bug Fixes

• Typo corrections in code and documentation.

• Addressed warnings in Docker builds.

• Fixed issues with Claimset import logic.

Breaking Changes

• Tenant endpoint is now read-only; management operations moved to new endpoints.

• ODS/API 6.0 introduces a breaking change in the security model.

Documentation

• Updated migration guides for Docker and IIS.

• Expanded developer docs for EF Core migrations and database updates.

• Updated OpenAPI documentation for v2.3.0.

Migration/Upgrade Notes

• Review updated migration guides before upgrading.

• If using custom tenants or security roles, review breaking changes in the security model.

• For ARM support, update Docker build and deployment scripts as needed.

v2.3.0

Pre-Release-v2.3.0

[ADMINAPI-1270] - Update db-admin image to version v1.4.3 in compose-…

v2.3.0-pre1

Pre-release for QA and security testing.

v2.2.2

This patch release addresses two bugs:

• A typo in the Docker startup script for Admin API, which caused the container to fail to launch.
• A typo in the Open API specification for the token endpoint, which caused usage problems in Swagger UI.

It also provides the following improvements in the Docker containers:

• Improved layer caching
• Updated base images
• Support for ODS/API 7.3

Packages:

• NuGet Package
• Docker Image

v2.2.1

What's Changed

• [ADMINAPI-950] SPIKE: Update documentation for Admin API limits and offsets by @jagudelo-gap in #123
• [ADMINAPI-68] Fix OnRelease Workflow to Delete Previous PreRelease *Tags* as well as GH Releases (2.x) by @jpardogrowthaccelerationpartners in #124
• [ADMINAPI-321] Admin API allows duplicate Applications by @jleiva-gap in #125
• [ADMINAPI-999] The property 'ProductionApiUrl' cannot be found on this object by @jpardogrowthaccelerationpartners in #128
• [ADMINAPI-1019] CLONE - AdminApi 2.1.0 and 2.2.0 fail importing claimsets with auth strategy overrides by @DavidJGapCR in #117
• [ADMINAPI-1022] CLONE - AdminApi 2.2.0 fails to access some claimsets by @jleiva-gap in #129
• [ADMINAPI-1023] CLONE - Admin Api 2.1.0 and 2.2.0 Unable to create applications with big int ids. by @jleiva-gap in #121
• [ADMINAPI-1024] Vendor delete issue in AdminAPI 2.x by @jleiva-gap in #120
• [ADMINAPI-1031] Include E2E tests to validate orderBy and direction by @DavidJGapCR in #135
• [ADMINAPI-1039] Fix Paginate and OrderBy by @jagudelo-gap in #144
• [ADMINAPI-1040] Remove v1 from swagger definition and Admin API by @jagudelo-gap in #145
• [ADMINAPI-1042] Fix e2e tests for order by and filter on multitenant mode by @DavidJGapCR in #142
• [ADMINAPI-1016] Load Admin API specifications by @jagudelo-gap in Ed-Fi-Alliance-OSS/Ed-Fi-API-Specifications#37
• [ADMINAPI-1028] Admin API to implement sorting and filtering on endpoints with "descendingSorting" to "direction" by @jleiva-gap in #131
• [ADMINAPI-1036] Resolve high and critical flags in Code Scanning for Admin API 2.3 release by @jagudelo-gap in #139
• [ADMINAPI-1045] Migration Guide by @jagudelo-gap in #149
• [ADMINAPI-1011] 2.x MSSQL Deployment in Docker Scenarios by @jleiva-gap in #138
• [ADMINAPI-1032] As a user I can create ods instances without instance type. by @jagudelo-gap in #137
• [ADMINAPI-1034] Release Admin API 2.2.1 by @jpardogrowthaccelerationpartners in #153
• [ADMINAPI-1035] Use SQL Server Express for Admin API Docker testing for MS SQL db by @jpardogrowthaccelerationpartners in #140
• [ADMINAPI-1044] We need to create more e2e tests to cover scenarios where the offset and limit are not required. by @jleiva-gap in #146
• [ADMINAPI-1049] Create documentation 2.2.1 by @jagudelo-gap in #155
• [ADMINAPI-951] Admin API to implement sorting and filtering on endpoints by @DavidJGapCR in #119
• [ADMINAPI-1030] Fixes on Swagger to MD by @jpardogrowthaccelerationpartners in #136
• [ADMINAPI-1038] Make offset and limit collections optional and set to their defaults when not provided by @jagudelo-gap in #141

Full Changelog: v2.2.0...v2.2.1

v2.2.0

What's Changed

• [ADMINAPI-983] Update Admin API 2 to .NET 8 by @CSR2017 in #98
• [ADMINAPI-977] Update actions, use correct URLs by @simpat-adam in #89
• [ADMINAPI-32] Swagger UI - Fix issue with displaying recursive type by @JBrenesSimpat in #94
• [ADMNAPI-989] Add read me file and fix docker file warnings by @CSR2017 in #96
• [ADMINAPI-982] Check if PostgreSQL is ready using pg_isready by @msilesgap in #104
• [ADMINAPI-755] Improve registration error handling by @simpat-adam in #103
• [ADMINAPI-1006] Fix using authority url instead of issuer by @simpat-adam in #109
• [ADMINAPI-1004] C# Improvements by @stephenfuqua in #108
• [ADMINAPI-984] Update installer for 2.2.0 release by @simpat-adam in #113

New Contributors

• @JBrenesSimpat made their first contribution in #90
• @elopezgap made their first contribution in #99
• @msilesgap made their first contribution in #104

Full Changelog: v2.1.1...v2.2.0

v2.1.1

Admin API 2.1.1 fixes security vulnerability in Microsoft.Data.SqlClient

v2.1.0

Admin API v2.1.0 supports Multi-tenants, ODS API 7.1

v2.0.1

Hotfix to resolve ADMINAPI-767: Changing Ed Org Id Leaves a Record Behind.