# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudbees Components API
  version: 1.0.0
extends: openapi/cloudbees-components-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: 6
- target: $.paths['/v4/organizations/{orgId}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List components in an organization
      effect: read
      questions:
      - Which components are registered in my CloudBees organization?
      - Can I filter my components to only those backed by GitHub?
      - Is there a way to find the component that uses a given repository clone URL?
      instructions:
      - text: List the components in organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Find the component named {name} in organization {orgId}.
        slots:
          name: query.name
          orgId: path.orgId
      - text: Show components in org {orgId} that use repository {repositoryUrl}.
        slots:
          repositoryUrl: query.repositoryUrl
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/organizations/{orgId}/components'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a component for a repository
      effect: write
      questions:
      - How do I register a new component for a git repository?
      - Can I create a component without an SCM integration?
      - What default branch does a new component get if I don't set one?
      instructions:
      - text: Create a component called {name} in org {orgId} for repo {repositoryUrl}.
        slots:
          name: requestBody.name
          orgId: path.orgId
          repositoryUrl: requestBody.repositoryUrl
      - text: Add component {name} for {repositoryUrl} in org {orgId} with default branch {defaultBranch}.
        slots:
          name: requestBody.name
          repositoryUrl: requestBody.repositoryUrl
          orgId: path.orgId
          defaultBranch: requestBody.defaultBranch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/organizations/{orgId}/components/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a component's details
      effect: read
      questions:
      - How can I see the details of one specific component?
      - What repository and default branch is a given component linked to?
      instructions:
      - text: Show component {id} in organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Get the repository URL and provider for component {id} in org {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/organizations/{orgId}/components/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a component
      effect: destructive
      questions:
      - How do I remove a component from my organization?
      - Can I delete a component that I no longer build?
      instructions:
      - text: Delete component {id} from organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Remove the component {id} in org {orgId} permanently.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/organizations/{orgId}/components/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a component
      effect: write
      questions:
      - How do I rename an existing component?
      - Can I change the description of a component after it was created?
      instructions:
      - text: Rename component {id} in org {orgId} to {name}.
        slots:
          id: path.id
          orgId: path.orgId
          name: requestBody.name
      - text: Change the description of component {id} in org {orgId} to {description}.
        slots:
          id: path.id
          orgId: path.orgId
          description: requestBody.description
      - text: Set the default branch of existing component {id} in org {orgId} to {defaultBranch}.
        slots:
          id: path.id
          orgId: path.orgId
          defaultBranch: requestBody.defaultBranch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{orgId}/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications and components together
      effect: read
      questions:
      - Where can I see both the applications and the components in my organization in one list?
      - Does the combined applications-and-components list include components with no repository?
      instructions:
      - text: List all applications and components in organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Show applications and components in org {orgId} filtered by type {typeFilter}.
        slots:
          orgId: path.orgId
          typeFilter: query.typeFilter
      method: generated
      generated: '2026-09-26'