# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Scorecards API
  version: 1.0.0
extends: openapi/harness-scorecards-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: 7
- target: $.paths['/v1/scorecards'].get
  update:
    x-apievangelist-phrasing:
      intent: List scorecards
      effect: read
      questions:
      - Which scorecards are set up in my internal developer portal?
      - Can I see all the scorecards used to grade services?
      instructions:
      - text: List all scorecards.
      - text: Show me every scorecard in the portal.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scorecards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scorecard with checks
      effect: write
      questions:
      - How do I create a scorecard to grade catalog components?
      - Which checks can I attach when creating a new scorecard?
      instructions:
      - text: Create scorecard {scorecard} with checks {checks}.
        slots:
          scorecard: requestBody.scorecard
          checks: requestBody.checks
      - text: Set up a new scorecard {scorecard}.
        slots:
          scorecard: requestBody.scorecard
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scorecards/{scorecard-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scorecard's details
      effect: read
      questions:
      - What checks make up a particular scorecard?
      - Where can I view one scorecard's configuration?
      instructions:
      - text: Get scorecard {id}.
        slots:
          id: path.scorecard-id
      - text: Show the checks in scorecard {id}.
        slots:
          id: path.scorecard-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scorecards/{scorecard-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scorecard and its checks
      effect: write
      questions:
      - Can I add or remove checks from an existing scorecard?
      - How do I edit a scorecard's settings?
      instructions:
      - text: Update scorecard {id} with checks {checks}.
        slots:
          id: path.scorecard-id
          checks: requestBody.checks
      - text: Edit scorecard {id} settings to {scorecard}.
        slots:
          id: path.scorecard-id
          scorecard: requestBody.scorecard
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scorecards/{scorecard-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scorecard
      effect: destructive
      questions:
      - How do I delete a scorecard we no longer use?
      - Can I remove a scorecard by its id?
      instructions:
      - text: Delete scorecard {id}.
        slots:
          id: path.scorecard-id
      - text: Remove scorecard {id} from the portal.
        slots:
          id: path.scorecard-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scorecards/{scorecard-id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scorecard's stats
      effect: read
      questions:
      - How are components scoring against a given scorecard?
      - What are the results and stats for one scorecard?
      instructions:
      - text: Get stats for scorecard {id}.
        slots:
          id: path.scorecard-id
      - text: Show how entities score on scorecard {id}.
        slots:
          id: path.scorecard-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entity-facets'].get
  update:
    x-apievangelist-phrasing:
      intent: Get entity facets for a catalog kind
      effect: read
      questions:
      - What filter facets are available for a given catalog entity kind?
      - Which owners, tags or lifecycles exist for components in the catalog?
      instructions:
      - text: Get the entity facets for kind {kind}.
        slots:
          kind: query.kind
      - text: List filterable facets for {kind} entities.
        slots:
          kind: query.kind
      method: generated
      generated: '2026-09-26'