Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Platform Configuration Trust Relationships API

6 actions 6 updates phrasing extends openapi/elk-stack-platformconfigurationtrustrelationships-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/platform/configuration/trust-relationships'].get
$.paths['/platform/configuration/trust-relationships'].post
$.paths['/platform/configuration/trust-relationships/{trust_relationship_id}'].get
$.paths['/platform/configuration/trust-relationships/{trust_relationship_id}'].put
$.paths['/platform/configuration/trust-relationships/{trust_relationship_id}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elastic Cloud Enterprise Platform Configuration Trust Relationships API
  version: 1.0.0
extends: openapi/elk-stack-platformconfigurationtrustrelationships-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/platform/configuration/trust-relationships'].get
  update:
    x-apievangelist-phrasing:
      intent: List trust relationships
      effect: read
      questions:
      - Which environments does my installation have trust relationships with?
      - Can the trust relationship list include each CA certificate?
      instructions:
      - text: List all trust relationships.
      - text: Show trust relationships with certificates included, include_certificate {include_certificate}.
        slots:
          include_certificate: query.include_certificate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/trust-relationships'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a trust relationship
      effect: write
      questions:
      - How do I set up trust with another environment so its deployments can connect to mine?
      - Can a new trust relationship trust all deployments by default?
      instructions:
      - text: Create trust relationship {name} using CA certificate {public_ca_cert}.
        slots:
          name: requestBody.name
          public_ca_cert: requestBody.public_ca_cert
      - text: Add trust {name} with CA {public_ca_cert}, trusting all deployments {trust_by_default}.
        slots:
          name: requestBody.name
          public_ca_cert: requestBody.public_ca_cert
          trust_by_default: requestBody.trust_by_default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/trust-relationships/{trust_relationship_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trust relationship
      effect: read
      questions:
      - What are the settings of one specific trust relationship?
      - Can I see the CA certificate on a single trust relationship?
      instructions:
      - text: Show trust relationship {trust_relationship_id}.
        slots:
          trust_relationship_id: path.trust_relationship_id
      - text: Get trust relationship {trust_relationship_id} with its certificate.
        slots:
          trust_relationship_id: path.trust_relationship_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/trust-relationships/{trust_relationship_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a trust relationship
      effect: write
      questions:
      - Can I rotate the CA certificate on an existing trust relationship?
      - How do I change which accounts a trust relationship covers?
      instructions:
      - text: Rename trust relationship {trust_relationship_id} to {name}.
        slots:
          trust_relationship_id: path.trust_relationship_id
          name: requestBody.name
      - text: Set account IDs {account_ids} on trust relationship {trust_relationship_id}.
        slots:
          trust_relationship_id: path.trust_relationship_id
          account_ids: requestBody.account_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/trust-relationships/{trust_relationship_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a trust relationship
      effect: destructive
      questions:
      - How do I remove trust with another environment?
      - Can I guard trust relationship deletion with a version check?
      instructions:
      - text: Delete trust relationship {trust_relationship_id}.
        slots:
          trust_relationship_id: path.trust_relationship_id
      - text: Remove trust {trust_relationship_id} at version {version}.
        slots:
          trust_relationship_id: path.trust_relationship_id
          version: query.version
      method: generated
      generated: '2026-09-26'