Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Platform Configuration Networking API

5 actions 5 updates phrasing extends openapi/elk-stack-platformconfigurationnetworking-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 5

$.info
$.paths['/platform/configuration/networking/deployment_domain_name'].get
$.paths['/platform/configuration/networking/deployment_domain_name'].put
$.paths['/platform/configuration/networking/deployment_domain_name/{resource_kind}'].get
$.paths['/platform/configuration/networking/deployment_domain_name/{resource_kind}'].put

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 Networking API
  version: 1.0.0
extends: openapi/elk-stack-platformconfigurationnetworking-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: 4
- target: $.paths['/platform/configuration/networking/deployment_domain_name'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default deployment domain name
      effect: read
      questions:
      - What default domain name are my ECE deployments published under?
      - Where can I see the platform-wide deployment domain setting?
      instructions:
      - text: Show the default deployment domain name.
      - text: Get the platform-wide deployment domain setting.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/networking/deployment_domain_name'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the default deployment domain name
      effect: write
      questions:
      - How do I change the default domain name used for deployment endpoints?
      - Can I skip cascading updates when changing the deployment domain name?
      instructions:
      - text: Set the default deployment domain name to {value}.
        slots:
          value: requestBody.value
      - text: 'Change the default deployment domain to {value} and skip cascading operations: {skip_cascading_operations}.'
        slots:
          value: requestBody.value
          skip_cascading_operations: query.skip_cascading_operations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/networking/deployment_domain_name/{resource_kind}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the deployment domain for a resource kind
      effect: read
      questions:
      - What domain name is used for Kibana or Elasticsearch resources specifically?
      - Can a resource kind have its own deployment domain name?
      instructions:
      - text: Get the deployment domain name for resource kind {resource_kind}.
        slots:
          resource_kind: path.resource_kind
      - text: Show which domain {resource_kind} resources use.
        slots:
          resource_kind: path.resource_kind
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/networking/deployment_domain_name/{resource_kind}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the deployment domain for a resource kind
      effect: write
      questions:
      - How do I give one resource kind its own deployment domain name?
      - Can I override the domain just for a specific kind of resource?
      instructions:
      - text: Set the deployment domain for {resource_kind} to {value}.
        slots:
          resource_kind: path.resource_kind
          value: requestBody.value
      - text: Override the {resource_kind} domain name to {value} at version {version}.
        slots:
          resource_kind: path.resource_kind
          value: requestBody.value
          version: query.version
      method: generated
      generated: '2026-09-26'