Cloudera · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudera Private Links API Service Cloudprivatelinks API

10 actions 10 updates phrasing extends openapi/cloudera-cloudprivatelinks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cloudera's API. It is a proposal applied on top of the contract, not a document Cloudera publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/cloudprivatelinks/authorizePrivateLinkServiceAccess'].post
$.paths['/api/v1/cloudprivatelinks/createPrivateLinkEndpoint'].post
$.paths['/api/v1/cloudprivatelinks/deletePrivateLinkEndpoint'].post
$.paths['/api/v1/cloudprivatelinks/getPrivateLinkStatus'].post
$.paths['/api/v1/cloudprivatelinks/listPrivateLinkEndpointStatuses'].post
$.paths['/api/v1/cloudprivatelinks/listPrivateLinkServicesForRegion'].post
$.paths['/api/v1/cloudprivatelinks/migratePrivateLinkEndpoints'].post
$.paths['/api/v1/cloudprivatelinks/revokePrivateLinkServiceAccess'].post
$.paths['/api/v1/cloudprivatelinks/updatePrivateLinkEndpoint'].post

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 Cloudera Private Links API Service Cloudprivatelinks API
  version: 1.0.0
extends: openapi/cloudera-cloudprivatelinks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/cloudprivatelinks/authorizePrivateLinkServiceAccess'].post
  update:
    x-apievangelist-phrasing:
      intent: Authorize Private Link service access for an account
      effect: write
      questions:
      - How do I allow my cloud account to connect to CDP over Private Link?
      - Can I grant Private Link access for just one region and service group?
      instructions:
      - text: Authorize Private Link service access for cloud account {cloudAccountId}.
        slots:
          cloudAccountId: requestBody.cloudAccountId
      - text: Grant Private Link access to Azure subscription {subscriptionId} in {region}.
        slots:
          subscriptionId: requestBody.subscriptionId
          region: requestBody.region
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/createPrivateLinkEndpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Create Private Link endpoints for a service group
      effect: write
      questions:
      - What does it take to stand up Private Link endpoints to the CDP control plane?
      - Can private DNS be turned on when the Private Link endpoints are created?
      instructions:
      - text: Create Private Link endpoints on {cloudServiceProvider} for service group {serviceGroup}.
        slots:
          cloudServiceProvider: requestBody.cloudServiceProvider
          serviceGroup: requestBody.serviceGroup
      - text: Provision new Private Link endpoints on {cloudServiceProvider} with private DNS enabled.
        slots:
          cloudServiceProvider: requestBody.cloudServiceProvider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/deletePrivateLinkEndpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete Private Link endpoints
      effect: destructive
      questions:
      - How do I tear down the Private Link endpoints I created for CDP?
      - Is it possible to remove Private Link endpoints from an Azure account specifically?
      instructions:
      - text: Delete the Private Link endpoints on {cloudServiceProvider}.
        slots:
          cloudServiceProvider: requestBody.cloudServiceProvider
      - text: Remove the CDP Private Link endpoints from my {cloudServiceProvider} account.
        slots:
          cloudServiceProvider: requestBody.cloudServiceProvider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/getPrivateLinkStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a Private Link
      effect: read
      questions:
      - Is the Private Link for my VPC working right now?
      - Can I check Private Link status by subnet or VNet instead of VPC?
      instructions:
      - text: Get the Private Link status for VPC {vpcId}.
        slots:
          vpcId: requestBody.vpcId
      - text: Check whether the Private Link for VNet {vNetId} is up.
        slots:
          vNetId: requestBody.vNetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/listPrivateLinkEndpointStatuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Track Private Link endpoints being created or deleted
      effect: read
      questions:
      - How far along is my Private Link endpoint creation?
      - Which endpoints are still mid-deletion under a tracking ID?
      instructions:
      - text: Show the endpoint statuses for Private Link tracking ID {trackingId}.
        slots:
          trackingId: requestBody.trackingId
      - text: Check progress of the Private Link endpoint job {trackingId}.
        slots:
          trackingId: requestBody.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/listPrivateLinkServicesForRegion'].post
  update:
    x-apievangelist-phrasing:
      intent: List Private Link services supported in a region
      effect: read
      questions:
      - Which Private Link services are available in my cloud region?
      - What service components map to each Private Link service for a service group?
      instructions:
      - text: List the Private Link services supported in {region}.
        slots:
          region: requestBody.region
      - text: Show Private Link services for service group {serviceGroup} in {region}.
        slots:
          serviceGroup: requestBody.serviceGroup
          region: requestBody.region
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/migratePrivateLinkEndpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate Private Link endpoints to control plane services
      effect: write
      questions:
      - How do I move my Private Link endpoints over to the control plane endpoint services?
      - Can AWS Private Link endpoints be migrated to fallback VPCE services?
      instructions:
      - text: Migrate the Private Link endpoints for AWS account {awsAccountInfo} to the control plane endpoint services.
        slots:
          awsAccountInfo: requestBody.awsAccountInfo
      - text: Move my AWS Private Link endpoints {awsAccountInfo} onto fallback VPCE services.
        slots:
          awsAccountInfo: requestBody.awsAccountInfo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/revokePrivateLinkServiceAccess'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke Private Link service access for an account
      effect: destructive
      questions:
      - How do I take away a cloud account's Private Link access to CDP?
      - Can Private Link access be revoked for a single region?
      instructions:
      - text: Revoke Private Link service access for cloud account {cloudAccountId}.
        slots:
          cloudAccountId: requestBody.cloudAccountId
      - text: Withdraw Private Link access for subscription {subscriptionId} in {region}.
        slots:
          subscriptionId: requestBody.subscriptionId
          region: requestBody.region
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/cloudprivatelinks/updatePrivateLinkEndpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Update existing Private Link endpoints
      effect: write
      questions:
      - Can I change the subnets on Private Link endpoints that already exist?
      - What changes can I make to my current Private Link endpoints' resource tags?
      instructions:
      - text: Update my existing Private Link endpoints to use subnets {subnetIds}.
        slots:
          subnetIds: requestBody.subnetIds
      - text: Change the resource tags on my existing {cloudServiceProvider} Private Link endpoints to {resourceTags}.
        slots:
          cloudServiceProvider: requestBody.cloudServiceProvider
          resourceTags: requestBody.resourceTags
      method: generated
      generated: '2026-10-01'