# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Rules API
  version: 1.0.0
extends: openapi/progress-software-rules-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: 8
- target: $.paths['/apis/iam/v2/apply-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the progress of a project update
      effect: read
      questions:
      - How far along is the project update that applies my rule changes?
      - Did the most recent project rules update finish successfully?
      instructions:
      - text: Check the status of the current project update.
      - text: Show the progress of applying project rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/apply-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply staged project rule changes
      effect: write
      questions:
      - How do I make my staged project rule edits take effect?
      - Why should I batch rule changes before starting a project update?
      instructions:
      - text: Start a project update to apply all pending rule changes.
      - text: Apply the staged project rules and move ingested resources into their projects.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/apply-rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an in-progress project update
      effect: destructive
      questions:
      - Can I stop a project update I just started because I forgot a rule change?
      - What state is the system left in if I cancel a project update?
      instructions:
      - text: Cancel the running project update.
      - text: Abort applying project rules right now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{id}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's ingest rules
      effect: read
      questions:
      - Which rules decide what resources land in a given project?
      - What ingest rules are set up on one of my projects?
      instructions:
      - text: List the rules for project {id}.
        slots:
          id: path.id
      - text: Show all ingest rules attached to project {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{project_id}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project rule
      effect: write
      questions:
      - How do I automatically move nodes from a certain Chef server into a project?
      - Can a new project rule match events by Chef organization?
      instructions:
      - text: Create {type} rule {id} named {name} in project {project_id} with conditions {conditions}.
        slots:
          type: requestBody.type
          id: requestBody.id
          name: requestBody.name
          project_id: path.project_id
          conditions: requestBody.conditions
      - text: Add a NODE rule {id} called {name} to project {project_id} matching {conditions}.
        slots:
          id: requestBody.id
          name: requestBody.name
          project_id: path.project_id
          conditions: requestBody.conditions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{project_id}/rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one project rule
      effect: read
      questions:
      - What conditions does a specific project rule use?
      - Is a given rule a NODE or EVENT rule?
      instructions:
      - text: Get rule {id} in project {project_id}.
        slots:
          id: path.id
          project_id: path.project_id
      - text: Show the conditions of project rule {id} in {project_id}.
        slots:
          id: path.id
          project_id: path.project_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{project_id}/rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project rule's name and conditions
      effect: write
      questions:
      - How do I change the conditions on an existing project rule?
      - Does editing a rule take effect right away, or only after a project update?
      instructions:
      - text: Update {type} rule {id} in project {project_id} to name {name} with conditions {conditions}.
        slots:
          type: requestBody.type
          id: path.id
          project_id: path.project_id
          name: requestBody.name
          conditions: requestBody.conditions
      - text: Overwrite the conditions of existing rule {id} in {project_id} with {conditions}, keeping type {type} and name {name}.
        slots:
          id: path.id
          project_id: path.project_id
          conditions: requestBody.conditions
          type: requestBody.type
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{project_id}/rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project rule
      effect: destructive
      questions:
      - How do I delete a project rule that's misrouting resources?
      - When does removing a rule actually change which resources are in the project?
      instructions:
      - text: Delete rule {id} from project {project_id}.
        slots:
          id: path.id
          project_id: path.project_id
      - text: Remove project rule {id} in {project_id}.
        slots:
          id: path.id
          project_id: path.project_id
      method: generated
      generated: '2026-10-01'