Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Registry Artifacts API

7 actions 7 updates phrasing extends openapi/apigee-artifacts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Apigee's API. It is a proposal applied on top of the contract, not a document Apigee publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/projects/{projectId}/locations/{locationId}/artifacts'].get
$.paths['/projects/{projectId}/locations/{locationId}/artifacts'].post
$.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}'].get
$.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}'].put
$.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}'].delete
$.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}:getContents'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Apigee Registry Artifacts API
  version: 1.0.0
extends: openapi/apigee-artifacts-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: 6
- target: $.paths['/projects/{projectId}/locations/{locationId}/artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List registry artifacts in a location
      effect: read
      questions:
      - What artifacts are stored at the project level in Apigee Registry?
      - Can I filter or sort the registry artifacts in a location?
      instructions:
      - text: List registry artifacts in project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show registry artifacts in {projectId}/{locationId} matching {filter}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a registry artifact
      effect: write
      questions:
      - How do I store a new artifact in the registry at the project level?
      - Can I set a MIME type on a new registry artifact?
      instructions:
      - text: Create registry artifact {artifactId} in project {projectId}, location {locationId}.
        slots:
          artifactId: query.artifactId
          projectId: path.projectId
          locationId: path.locationId
      - text: Store artifact {artifactId} with MIME type {mimeType} in the registry for {projectId}/{locationId}.
        slots:
          artifactId: query.artifactId
          mimeType: requestBody.mimeType
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registry artifact's metadata
      effect: read
      questions:
      - What size and hash does a registry artifact have?
      - Where do I see the details of one artifact in the registry?
      instructions:
      - text: Get registry artifact {artifactId} in project {projectId}, location {locationId}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the metadata of artifact {artifactId} in {projectId}/{locationId}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a registry artifact's contents
      effect: write
      questions:
      - How do I overwrite the contents of an existing registry artifact?
      - Can I swap the data stored in an artifact without recreating it?
      instructions:
      - text: Replace the contents of registry artifact {artifactId} in project {projectId}, location {locationId}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
      - text: Overwrite artifact {artifactId} in {projectId}/{locationId} with contents {contents}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
          contents: requestBody.contents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registry artifact
      effect: destructive
      questions:
      - How do I remove an artifact from the registry?
      - Is deleting a project-level registry artifact permanent?
      instructions:
      - text: Delete registry artifact {artifactId} in project {projectId}, location {locationId}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove artifact {artifactId} from the registry in {projectId}/{locationId}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/artifacts/{artifactId}:getContents'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registry artifact's raw contents
      effect: read
      questions:
      - How do I download the raw data stored in a registry artifact?
      - Can I read an artifact's content rather than its metadata?
      instructions:
      - text: Get the raw contents of registry artifact {artifactId} in project {projectId}, location {locationId}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
      - text: Download the data in artifact {artifactId} from {projectId}/{locationId}.
        slots:
          artifactId: path.artifactId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'