-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
EES-5396 Sync public API OpenAPI changes with API docs #5445
Open
ntsim
wants to merge
9
commits into
dev
Choose a base branch
from
ees-5396
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
ntsim
force-pushed
the
ees-5396
branch
2 times, most recently
from
December 9, 2024 18:20
57b6e4a
to
b09c5ca
Compare
src/GovUk.Education.ExploreEducationStatistics.Public.Data.Api/Startup.cs
Outdated
Show resolved
Hide resolved
...Statistics.Public.Data.Api/GovUk.Education.ExploreEducationStatistics.Public.Data.Api.csproj
Show resolved
Hide resolved
...Statistics.Public.Data.Api/GovUk.Education.ExploreEducationStatistics.Public.Data.Api.csproj
Show resolved
Hide resolved
infrastructure/templates/public-api/application/public-api/publicApiApp.bicep
Outdated
Show resolved
Hide resolved
|
||
set -u | ||
|
||
# This script should be ran from inside the oasdiff Docker container. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick but should ran
be run
?
ntsim
force-pushed
the
ees-5396
branch
18 times, most recently
from
December 19, 2024 22:06
07032b6
to
43befe7
Compare
duncan-at-hiveit
approved these changes
Dec 20, 2024
This substantially improves build times as the monolithic Backend job was previously running a bunch of things serially.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR adds a syncing mechanism to ensure that OpenAPI changes in the public API are documented in the API docs.
To enable this:
Once this diff has been resolved, the build can pass and deployment can proceed.
The API docs deployment has now been adjusted so that they are built during the build itself. We need to do this as
Related changes
/api
prefix fromopenapi-v1.json
in the API docs.Startup
to enable the Swashbuckle CLI to work.Other changes