feat(ipa): Decouple property descriptions from API mechanics in IPA-117#57
Open
AgustinBettati wants to merge 1 commit into
Open
feat(ipa): Decouple property descriptions from API mechanics in IPA-117#57AgustinBettati wants to merge 1 commit into
AgustinBettati wants to merge 1 commit into
Conversation
AgustinBettati
force-pushed
the
CLOUDP-412565-ipa-117-description-hygiene
branch
from
9290cfc to
6a1bff9
Compare
Adds guidance that descriptions should be meaningful to API consumers rather than coupled to API mechanics (operation IDs, request/response object names, endpoint paths), and that a property's description should be consistent across oneOf variants, so downstream tooling does not need description overrides. CLOUDP-412565
AgustinBettati
force-pushed
the
CLOUDP-412565-ipa-117-description-hygiene
branch
from
6a1bff9 to
4e3a2a3
Compare
AgustinBettati
requested review from
andreaangiolillo,
drinkbird,
lovisaberggren,
maks-m-mongo-leaf,
matt-condon,
saisundar and
wtrocki
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.
Summary
Adds two bullets to IPA-117
### Descriptions:oneOfvariants, its description should be consistent; variant-specific context belongs in the variant's own description.This keeps generated SDK and IaC-provider descriptions free of API-internal construct names, so downstream tooling does not need description overrides.
Part of the CLOUDP-356095 epic. Resolves CLOUDP-412565.