docs: document required schemas and capability advertisement for composition functions#1064
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…osition functions
- Add Required schemas section: functions can request OpenAPI schemas via
requirements.schemas; Crossplane populates required_schemas (Fixes crossplane#1040).
- Add Capability advertisement section: meta.capabilities lists supported
features; functions should check and fall back (Fixes crossplane#1041).
- Add intro mention of meta.capabilities in How composition functions work.
- Crossplane v2.2+; references design one-pagers and PR 7022.
Signed-off-by: Kruthi Wusirika <kruthiwusirika@gmail.com>
kruthiwusirika5
force-pushed
the
docs/required-schemas-and-capabilities
branch
from
49c2d7c to
c755c14
Compare
|
This PR is ready for review when someone has time. Summary: Documents two composition function features (Fixes #1040, #1041): (1) Required schemas — how functions request OpenAPI schemas via Netlify deploy preview is ready. Happy to adjust wording or scope. |
1 participant
What
requirements.schemas; Crossplane populatesrequired_schemason the next request. Covers bootstrap (Composition) and dynamic requests, with a YAML example.RequestMeta.capabilities—Crossplane lists supported protocol features so functions can check before using a feature and fall back on older controllers. Includes capability table and Python example.meta.capabilitiesin "How composition functions work" with a link to the new section.Why
Content requested in #1040 and #1041; implementation is in crossplane/crossplane#7022 (v2.2). Matches existing style (e.g. Required resources section).