feat: expose schemaId on /policies/{id}/about entries#6022
Open
feat: expose schemaId on /policies/{id}/about entries#6022
Conversation
Walk policy.config to map block tag → options.schema and attach the schema IRI to each alias entry returned by the documentation endpoint. Signed-off-by: Alex Piatakov <alex.piatakov@swirldslabs.com>
Pyatakov
modified the milestones:
Automated Policy Testing & Stabilization,
UI / UX, Docs, & API
Test Results 32 files ±0 64 suites ±0 4m 2s ⏱️ -15s For more details on these failures, see this check. Results for commit 8ed5abc. ± Comparison against base commit 4fa0f13. ♻️ This comment has been updated with latest results. |
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
1 participant
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
policy.configingetPolicyDocumentationto map block tag →options.schemaand attach the resulting IRI to each alias entry asschemaId.findBlocksfrom@guardian/commonfor the traversal; skip the walk entirely when there are no documented entries.schemaId?: stringtoIPolicyDocumentationEntry.docs/guardian/policy-api-documentation-and-dmrv-aliases.mdwith a note and a second response example covering the new field.