Add guidance for the finder schema #4781
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
GDSNewt
force-pushed
the
finder-schema-documentaion
branch
from
4a92436
to
54603f6
Compare
GDSNewt
force-pushed
the
finder-schema-documentaion
branch
from
54603f6
to
2f7934c
Compare
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.
To increase knowledge of the Specialist Publisher application, we thought we could do some digging into the finder schema and provide some additional documentation on what it controls on GOV.UK.
The constraints of the developer docs mean that it is currently just taking the form of a simple table, I hope this proves readable enough, but suggestions on how this could be improved would be welcome.
Whilst researching the finder schema I came across a few properties that seem deprecated and barely used. I believe there is a discussion to be had on whether we should remove some of these. I have raised an issue in the publishing api repo.
For now though I have simply documented what the intention behind each property is/was.
Trello