Skip to content

Align governance API schemas with runtime responses - #8108

Draft
achamayou with Copilot wants to merge 1 commit into
mainfrom
copilot/resolve-items-1-3-issue-8093
Draft

Align governance API schemas with runtime responses#8108
achamayou with Copilot wants to merge 1 commit into
mainfrom
copilot/resolve-items-1-3-issue-8093

Conversation

Copilot AI commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

The governance OpenAPI schemas diverged from the service-state responses for JWT issuers, JWK metadata, and join policies.

  • JWT issuers

    • Remove the unsupported preview keyFilter field.
  • JWK metadata

    • Model each key ID as an array of entries.
    • Describe publicKey, issuer, and optional constraint fields.
  • Join policies

    • Represent SGX and SNP measurements and host-data digests as hexadecimal.
    • Keep virtual measurements and SNP host-data metadata as unencoded strings.

Co-authored-by: achamayou <4016369+achamayou@users.noreply.github.com>
Copilot AI changed the title Correct governance API response schemas Align governance API schemas with runtime responses Jul 29, 2026
Copilot AI requested a review from achamayou July 29, 2026 14:37
@eddyashton

eddyashton commented Jul 30, 2026

Copy link
Copy Markdown
Member

Ah this is a mess. We have changed the format of the responses with the 2023-06-01-preview and 2024-07-01 API versions a few times (returning an array of JwkInfos, returning publicKey and constraint fields). The intent of the explicit API versions was to provide a stable API surface, but we've never enforced it, and clearly nobody downstream has noticed/cared. I'm not sure what the right route here is - continue to tweak these previously-generated API docs so they accurately describe the runtime behaviour, but rely on agent audit to keep them in-sync? Revert the runtime changes so the docs are accurate? Introduce a new API version that defers to our existing auto-schema generation to stay in-sync?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants