Add pre-application advice to swagger examples #2068
Merged
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
pixeltrix
force-pushed
the
add-preapp-to-swagger
branch
from
09f226e to
86d7201
Compare
benjamineskola
approved these changes
Dec 10, 2024
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.
Description of change
Add pre-application example to swagger
Story Link
https://trello.com/c/iWGN8LwR
Known issues
The main branch of the ODP schemas repo has a broken version of the pre-application schema and example because the build scripts were failing. To workaround this the PR uses a fixed version from theopensystemslab/digital-planning-data-schemas#281 which adds the
data.application.type. The intent is to migrate to a root levelapplicationTypekey but this is left until the work on the prototypeApplication schema is complete.The format of the files in the pre-application example is different to the application schema with a simple string being returned instead of an object. To workaround this we do a type check and copy the tag to both the
tagsanddescriptioncolumn because there's no lookup within BOPS for the description.