[ADMINAPI-1435] Update the OpenAPI action - #418
Merged
Conversation
Documents the plan to fix build.ps1's v2-only OpenAPI export, drop widdershins markdown generation, and replace the branch/PR flow in openapi-md.yml with a manually-dispatchable + weekly-scheduled workflow that publishes v2/v3 yaml specs as run artifacts instead of committing anywhere. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Two-task plan covering build.ps1 fixes (v2+v3 generation, widdershins removal, command rename) and the openapi-md.yml rewrite (optional version input with latest fallback, weekly schedule, artifact upload instead of branch/commit/PR). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ion bump, ref-based checkout - v2 and v3 docs must be generated from two separate build/run passes with AdminApiMode flipped between them, since it gates which endpoints the app registers at startup - a single static build can only produce one correct doc. - Swashbuckle.AspNetCore.Cli bumped 6.6.2 -> 10.2.3 (6.6.2 predates .NET 10 support). - workflow_dispatch version input now resolves to a git ref (semver -> vX.Y.Z tag, raw string -> branch/ref as-is, blank -> main) instead of always building whatever triggered the dispatch, restoring the original intent of targeting a specific released version. Documented as forward-only: only works for refs created after this change merges. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…iddershins markdown generation
…, add weekly schedule
…g and remove markdown generation
Contributor
Test Results 15 files 15 suites 1m 9s ⏱️ Results for commit 3523a12. |
DavidJGapCR
approved these changes
Aug 4, 2026
jpardogrowthaccelerationpartners
approved these changes
Aug 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces several improvements to OpenAPI documentation generation, enhances endpoint response metadata, and refines the workflow for generating OpenAPI specs. The most significant changes are the addition of new Swashbuckle operation filters to improve OpenAPI accuracy, updates to endpoint response conventions (especially for 201 responses), and workflow improvements for OpenAPI artifact generation.
OpenAPI Documentation Improvements
LocationHeaderOperationFilterdocuments the "Location" header on 201 responses, allowing for endpoint-specific descriptions via new metadata.AnonymousOperationSecurityFilterensures endpoints allowing anonymous access do not require OAuth in the generated spec.ProblemDetailsResponseOperationFilterdocuments theapplication/problem+jsonerror response for all 4xx/5xx responses.WebApplicationBuilderExtensions.cs.Endpoint Response Metadata Enhancements
WithResponseCodeandWithResponse<T>to accept an optionallocationDescriptionparameter, and addedLocationHeaderDescriptionMetadatato support custom "Location" header descriptions for 201 responses. [1] [2]OpenAPI Generation Workflow Improvements
.github/workflows/openapi-md.ymlto:Swashbuckle.AspNetCore.Clito version 7.1.0.Code Quality and Consistency
JobQueuedResult) for clarity and type safety. [1] [2] [3]Security and Configuration
Tested on
https://github.com/jagudelo-gap/ODS-Admin-API/actions/runs/30849728697