Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Environment Reviews API

4 actions 4 updates phrasing extends openapi/canonical-environment-reviews-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Canonical's API. It is a proposal applied on top of the contract, not a document Canonical publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/artefacts/{artefact_id}/environment-reviews'].get

$.paths['/v1/artefacts/{artefact_id}/environment-reviews'].patch

$.paths['/v1/artefacts/{artefact_id}/environment-reviews/{review_id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Test Observer Environment Reviews API
  version: 1.0.0
extends: openapi/canonical-environment-reviews-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: 3
- target: $.paths['/v1/artefacts/{artefact_id}/environment-reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List environment reviews for an artefact
      effect: read
      questions:
      - What review decisions have been made for each environment an artefact was tested on?
      - Can I see which environments still need review for an artefact?
      instructions:
      - text: List environment reviews for artefact {artefact_id}.
        slots:
          artefact_id: path.artefact_id
      - text: Show review status per environment of artefact {artefact_id}.
        slots:
          artefact_id: path.artefact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/artefacts/{artefact_id}/environment-reviews'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update many environment reviews at once
      effect: write
      questions:
      - Can I approve several environment reviews of an artefact in one request?
      - Is there a bulk way to record review decisions across environments?
      instructions:
      - text: Bulk update the environment reviews of artefact {artefact_id}.
        slots:
          artefact_id: path.artefact_id
      - text: Apply review decisions to all listed environments of artefact {artefact_id}.
        slots:
          artefact_id: path.artefact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/artefacts/{artefact_id}/environment-reviews/{review_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Record a decision on one environment review
      effect: write
      questions:
      - How do I approve or reject a single environment's test results for an artefact?
      - Can I leave a comment on one environment review?
      instructions:
      - text: Set review {review_id} of artefact {artefact_id} to decision {decision}.
        slots:
          review_id: path.review_id
          artefact_id: path.artefact_id
          decision: requestBody.review_decision
      - text: Comment {comment} on environment review {review_id} for artefact {artefact_id}.
        slots:
          comment: requestBody.review_comment
          review_id: path.review_id
          artefact_id: path.artefact_id
      method: generated
      generated: '2026-09-26'