Versions Compared

Version Old Version 2 New Version Current
Changes made by

Michelle Tubbs

Michelle Tubbs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Client-side SDK code generation

Create a folder called IDOE_SDK and open a PowerShell terminal window from that folder. In a PowerShell command window execute these commands to generate the SDK.

Note: The commands below require java to be installed on your machine. If you do not have the latest version of Java23, please download and install it from this link https://www.oracle.com/java/technologies/downloads/

Expand
titleExecute this command to download the latest verion of the OpenApi Codegen JAR 7.9.0

Invoke-WebRequest -OutFile openApi-codegen-cli.jar  https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.9.0/openapi-generator-cli-7.9.0.jar

Expand
titleExecute this command to create SKD for all Ed-Fi ODS Api and models including IDOE extensions and descriptors

java -jar openApi-codegen-cli.jar generate -g csharp -i

https://doe-edfiods-a-v-v2026-ca.ashytree-64da9ba4.eastus.azurecontainerapps.io/2026/metadata/data/v3/swagger.json --api-package Apis --model-package Models -o ./IDOEOdsApi --additional-properties packageName=EdFi.OdsApi.Sdk,targetFramework=net8.0,netCoreProjectFile=true --global-property modelTests=false --global-property apiTests=false --skip-validate-spec 

Expand
titleExecute this command to create the IDOE Identities

java -jar openApi-codegen-cli.jar generate -g csharp -i

https://doe-edfiods-a-v-v2026-ca.ashytree-64da9ba4.eastus.azurecontainerapps.io/2026/metadata/idoeidentity/v2/swagger.json --api-package IdentityApis --model-package IdentityModels -o ./IDOEIdentities --additional-properties packageName=EdFi.OdsApi.IDOEIdentities.Sdk,targetFramework=net8.0,netCoreProjectFile=true --global-property modelTests=false --global-property apiTests=false --skip-validate-spec

Expand
titleExecute command to create SDK for IDOE Attendance Bulk

java -jar openApi-codegen-cli.jar generate -g csharp -i

https://doe-edfiods-a-v-v2026-ca.ashytree-64da9ba4.eastus.azurecontainerapps.io/2026/metadata/idoeattendance/v1/swagger.json --api-package AttendanceBulkApis --model-package AttendanceBulkModels -o ./IDOEAttendanceBulk --additional-properties packageName=EdFi.OdsApi.IDOEAttendanceBulk.Sdk,targetFramework=net8.0,netCoreProjectFile=true --global-property modelTests=false --global-property apiTests=false --skip-validate-spec

...