feat(ipa): enrich IPA-104 Get with Guideline components#65
Draft
andmatei wants to merge 1 commit into
Draft
Conversation
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.
Enriches IPA-104 (Get) with the
<Guideline>component family, per CLOUDP-399898.Decomposes the document's existing guidance into 15 atomic guidelines (9 lintable / 4 unlintable / 2 informational), each carrying structured metadata (
id,given,effort,lintable/informational/implementation,dependsOn). Every non-informational guideline has an<Example.Correct>+<Example.Incorrect>(each with an<Example.Reason>); every unlintable guideline has a<Workflow>. Original prose is preserved verbatim; the file is converted.md→.mdx, and inbound.mdlinks from other docs are repointed to.mdx.lintableflags map to rules in the mongodb/openapiIPA-104Spectral ruleset.Validation:
npm run docusaurus:buildandnpm run lintpass (clean-cache build).Stacked PR based on
CLOUDP-399897-ipa-103-methods(stack: 100 → 101 → 102 → 103 → 104; review/merge bottom-up, GitHub retargets tomainas each parent merges).Jira: CLOUDP-399898