API Evangelist conversational phrasing for Extensibility API Resource API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Extensibility API Resource API
  version: 1.0.0
extends: openapi/conga-api-resource-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: 12
- target: $.paths['/api/extensibility/v1/customcode/api-resource'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom API resources
      effect: read
      questions:
      - Which custom API resources have been defined in custom code?
      - Can I filter custom API resources by a name prefix?
      instructions:
      - text: List all custom API resources.
      - text: Show API resources whose names start with {startsWithFilter}.
        slots:
          startsWithFilter: query.startsWithFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom API resource
      effect: write
      questions:
      - How do I define a new custom API resource backed by custom code?
      - What's needed to create an empty API resource before adding routes?
      instructions:
      - text: Create a custom API resource named {Name}.
        slots:
          Name: requestBody.Name
      - text: Add new API resource {Name} for my custom code.
        slots:
          Name: requestBody.Name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/cancellation/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the custom API cancellation timeout
      effect: read
      questions:
      - How long can a custom API call run before it is cancelled?
      - Where can I see the custom API cancellation token setting?
      instructions:
      - text: Show the custom API cancellation settings.
      - text: Get the abort timeout configured for custom API calls.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/cancellation/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the custom API cancellation timeout
      effect: write
      questions:
      - How do I change when long-running custom API calls are cancelled?
      - Can I create the cancellation setting for custom APIs if it doesn't exist yet?
      instructions:
      - text: Set the custom API abort timeout to {ExecutionAbortTimeout} milliseconds.
        slots:
          ExecutionAbortTimeout: requestBody.ExecutionAbortTimeout
      - text: Upsert the custom API cancellation setting with timeout {ExecutionAbortTimeout} ms.
        slots:
          ExecutionAbortTimeout: requestBody.ExecutionAbortTimeout
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/resolve'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve a custom API route to its URI entry
      effect: read
      questions:
      - Which custom code method will handle a given resource path and HTTP verb?
      - Can I test how a custom API request resolves before calling it?
      instructions:
      - text: Resolve {HttpVerb} {ResourcePath} on API resource {ResourceName}.
        slots:
          HttpVerb: requestBody.HttpVerb
          ResourcePath: requestBody.ResourcePath
          ResourceName: requestBody.ResourceName
      - text: Find which URI entry handles path {ResourcePath} in resource {ResourceName}.
        slots:
          ResourcePath: requestBody.ResourcePath
          ResourceName: requestBody.ResourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom API resource by name
      effect: read
      questions:
      - What is configured on a particular custom API resource?
      - Can I fetch one API resource's details by its name?
      instructions:
      - text: Get custom API resource {name}.
        slots:
          name: path.name
      - text: Show the configuration of API resource {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom API resource
      effect: destructive
      questions:
      - How do I remove a custom API resource I no longer use?
      - Does deleting an API resource validate it first?
      instructions:
      - text: Delete custom API resource {name}.
        slots:
          name: path.name
      - text: Remove API resource {name} and its information.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/{name}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a custom API resource
      effect: write
      questions:
      - Can I copy an existing API resource along with all its URI entries?
      - How do I duplicate a custom API resource under a new name?
      instructions:
      - text: Clone API resource {name} as {Name}.
        slots:
          name: path.name
          Name: requestBody.Name
      - text: Duplicate custom API resource {name} with its routes into a new resource {Name}.
        slots:
          name: path.name
          Name: requestBody.Name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/{name}/uri-entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a custom API resource's URI entries
      effect: read
      questions:
      - Which routes are defined on a custom API resource?
      - Can I list only the POST URI entries of an API resource?
      instructions:
      - text: List URI entries for API resource {name}.
        slots:
          name: path.name
      - text: Show the {httpVerb} routes on API resource {name}.
        slots:
          httpVerb: query.httpVerb
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/{name}/uri-entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a route to a custom API resource
      effect: write
      questions:
      - How do I map a new route on my API resource to a custom code method?
      - Can I bind an HTTP verb and route to a specific class and method?
      instructions:
      - text: Add a {HttpVerb} route {Route} to API resource {name} calling method {MethodName}.
        slots:
          HttpVerb: requestBody.HttpVerb
          Route: requestBody.Route
          name: path.name
          MethodName: requestBody.MethodName
      - text: Create a URI entry on {name} that runs custom code {CustomCodeName}, class {FullyQualifiedClassName}.
        slots:
          name: path.name
          CustomCodeName: requestBody.CustomCodeName
          FullyQualifiedClassName: requestBody.FullyQualifiedClassName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/{name}/uri-entries/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a route on a custom API resource
      effect: write
      questions:
      - How do I change which method an existing API resource route calls?
      - Can I edit the route or verb of a URI entry I already created?
      instructions:
      - text: Update URI entry {id} on API resource {name} to call method {MethodName}.
        slots:
          id: path.id
          name: path.name
          MethodName: requestBody.MethodName
      - text: Change the route of existing entry {id} in resource {name} to {Route}.
        slots:
          id: path.id
          name: path.name
          Route: requestBody.Route
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/api-resource/{name}/uri-entries/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a route from a custom API resource
      effect: destructive
      questions:
      - How do I remove one route from a custom API resource?
      - Can I delete a single URI entry without deleting the resource?
      instructions:
      - text: Delete URI entry {id} from API resource {name}.
        slots:
          id: path.id
          name: path.name
      - text: Remove route {id} on custom API resource {name}.
        slots:
          id: path.id
          name: path.name
      method: generated
      generated: '2026-10-01'