Add doc strings for common bundle resource fields#5664
Draft
radakam wants to merge 1 commit into
Draft
Conversation
Document the common fields DABs injects across resources in the bundle JSON schema: permissions, lifecycle, and grants. These previously showed empty tooltips/docs on many resources. - permissions: fill the 8 SDK-typed variants' item subfields (level, user_name, service_principal_name, group_name) and add a field-level description, markdown_description, and example on all resources. - lifecycle: propagate the existing field-level description to the resources where it was still a placeholder. - grants: add a field-level description, markdown_description, and example on the UC resources (subfields come from the SDK). Regenerated bundle/schema/jsonschema.json.
Collaborator
Integration test reportCommit: 129fe26
25 interesting tests: 13 SKIP, 6 RECOVERED, 4 flaky, 2 FAIL
Top 23 slowest tests (at least 2 minutes):
|
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
2 participants
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.
Changes
Document the common fields DABs injects across resources in the bundle JSON schema, which previously rendered empty tooltips/docs on many resources:
permissions— fill the 8 SDK-typed variants' item subfields (level,user_name,service_principal_name,group_name) and add a field-level description +markdown_description+ example on all resources.lifecycle— propagate the existing field-level description to the resources where it was still a placeholder.grants— add a field-level description +markdown_description+ example on the UC resources (subfields come from the SDK).Regenerated
bundle/schema/jsonschema.json. Resolves DECO-2769 (the ticket's other named type,Paths, is an internal struct removed in #1673, so nothing to document there).Why
These are the cross-cutting fields DABs owns on every resource, but their docs were only partially filled, so editor completions and the docs site showed blanks inconsistently. The remaining schema placeholders are resource-specific API fields whose descriptions belong upstream in the OpenAPI spec, not as CLI-only overrides, so they are intentionally left out.
Tests
Docs-only/schema change.
go test ./bundle/internal/schema/...passes, which verifies regeneration from the committed annotations is a no-op (no stale or missing placeholders).