Skip to content

Conversation

@JBrenesSimpat
Copy link
Contributor

@JBrenesSimpat JBrenesSimpat commented Nov 20, 2025

To Test the creation of instance for a range of years:

Uncomment ROUTE_QUALIFIER_SEGMENTS in the .env file and set the value equals to schoolYear
ROUTE_QUALIFIER_SEGMENTS=schoolYear

Then, execute:
./start-local-dms.ps1 -EnableConfig -EnvironmentFile ./.env -EnableSwaggerUI -LoadSeedData -SchoolYearRange "2022-2026" -r

Also can follow instructions on eng/docker-compose/SCHOOL_YEAR_INSTANCES.md

image

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a school year dropdown selector to the Swagger UI, allowing users to switch between multiple DMS instances configured for different school years. The implementation extracts school year information from the OpenAPI specification's server variables and dynamically populates a dropdown selector.

Key Changes:

  • Modified OpenAPI spec generation to include school year variables extracted from DMS instances
  • Added Swagger UI plugin to render school year selector and intercept API requests
  • Created PowerShell tooling to automate creation of school year instances

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
MetadataEndpointModule.cs Enhanced GetServers() to extract school years from DMS instances and generate OpenAPI server variables
verify-school-year-instances.http Added HTTP test file to verify school year instance setup
start-local-dms.ps1 Added -SchoolYearRange parameter to create multiple school year instances
swagger-initializer.js Added school year plugin registration and request interceptor logic
index.html Included new school year plugin script
edfi-school-year-from-spec.js New plugin extracting school years from spec and rendering UI selector
SCHOOL_YEAR_INSTANCES.md Documentation for school year instance setup
Dms-Management.psm1 Added functions for creating school year instances and route contexts

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@JBrenesSimpat JBrenesSimpat marked this pull request as ready for review November 20, 2025 15:31
@jleiva-gap jleiva-gap merged commit b0bccc9 into main Nov 21, 2025
33 checks passed
@jleiva-gap jleiva-gap deleted the DMS-865 branch November 21, 2025 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants