What's New - Admin API 1.x

Owned by Jason Hoekstra
Last updated: Oct 17, 2024
3 min read

This section provides an overview of what's new in the latest versions of the Admin API 1.x, which is used for ODS / API 5.x and 6.x.

Contents

Updates in Admin API 1.4.2 (Latest Release)

Bug

ADMINAPI-742 There is no way to set Applications.OdsInstance\_OdsInstanceId via the API in Admin API 1.3

ADMINAPI-755 An error is thrown in the response instead of a warning message when registration is disabled

ADMINAPI-986 Workflow bug in "Release EdFi.Security.DataAccess Compatibility 5.3"

ADMINAPI-1007 Using Authority Setting for JWT Issuer \(Admin API 1\)

ADMINAPI-1026 CLONE \(1.x\) - Fix OnRelease Workflow to Delete Previous PreRelease \Tags\ as well as GH Releases

ADMINAPI-1047 When you create an Application with Admin API it will not show in Admin App

Task

ADMINAPI-988 code owners file for Admin API 1

ADMINAPI-991 Update libxml

Story

ADMINAPI-993 Incorporate the OSSF scorecard in to AdminaApi repos

ADMINAPI-1003 Ensure Admin API endpoints have paging \(limits and offset\) implemented - 1.x

ADMINAPI-1012 1.x MSSQL Deployment in Docker Scenarios

ADMINAPI-1056 Investigate Admin API 1.x build errors for EntityFrameworkCore

ADMINAPI-1072 Test and QA for Admin API 1.4.2

ADMINAPI-1073 Release Admin API 1.4.2

Document

ADMINAPI-645 Document practice example of creating multiple key/secret pairs from vendor listing file \(1.x\)

ADMINAPI-1027 CLONE - various documentation updates needed for 1x adminApi

Updates in Admin API v1.4 

.NET 8 Upgrade for Admin API 1

Admin API 1.4 has been updated to .NET 8 for performance, security and other updates.

Swagger UI - Fix issue with displaying recursive type

Swagger UI is not displaying the proper type description (with properties) on recursive types. On the screen shot below - the children are collection of "ResourceClaim" type. But it is showing array of string.

Dockerfile improvements and documentation

Various updates for better Dockerfile usage and documentation, including improving security by running the application as a non-root user.

Updates in Admin API v1.3 

Refactor Admin API for Clean Separation

Admin API 1.3 has been refactored for more separation from Admin App, which was originally the development base for Admin API.

 

Return Vendor and Profile IDs in /applications Endpoints

A field report requested that vendor and profile IDs should be returned as part of the /applications endpoint, which has now been included in Admin API 1.3.

 

Update System.Data.SqlClient to Microsoft.Data.SqlClient

Due to a recommendation from Microsoft, we have updated the data access library to use Microsoft.Data.SqlClient instead of System.Data.SqlClient.

Disable Shell Debug Messages in Docker

A field report requested to repress logging of certain elements in Docker configurations.

Changing Ed Org Id Leaves a Record Behind

A bug was discovered where changing an education organization identifier leaves behind additional data affecting ed org hierarches and data access.  The Admin API 1.3.1 update resolves the issue for this use case.

Other Updates

Other technical product updates, such as consolidating namespaces and library renaming, have also been included in this update.  Please see the Admin API 1.3 release report for full details.

Bug Fixes in Admin API 1.3.2

  • Expand EdOrgs to return as an array instead of single value

  • Claimset endpoint inconsistencies, fix to enable ODS/API v6 updates

  • When the number of nulls sent in 'authStrategyOverridesForCRUD' is not the same as in 'ResourceClaims' the application throws an error but the ClaimSets is created anyway

  • Refactor ODS Security version resolver implementation

  • ReadChanges action not returned in AdminAPI 1.3.1 for ODS/API 5.3-cqe

  • Admin API 1.3.2 - Admin API POST application makes new incorrect rows in dbo.users table

  • AdminApi - docker scout vulnerability list

  • Using53Cqe=true does not return auth strategy overrides for that action

Updates in Admin API v1.2

Multiple Security Model / ODS Version Support

The ODS/API Platform has two different security models in versions 3.4-5.3 and 6.0-6.1.  This version of Admin API supports both versions of that security model with the same operation endpoints for management via API (ODS/API v3.4-5.3 and v6.0-v6.1 and future versions may be supported).

Updates in Admin API v1.1

Claim Sets

Admin API v1.1 provides support to importing and exporting claim sets via API. Admin API is available as both a standalone installation under IIS and as a Docker deployment.  Admin API v1.1 supports ODS/API v3.4 to v5.3.

Updates in Admin API v1.0

Initial Release

This is the initial release of Admin API v1.0.  It provides functionality to create vendors, applications, and credentials within an Ed-Fi ODS / API Platform instance. Admin API is available as both a standalone installation under IIS and as a Docker deployment.