Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Wiki Wiki Pages API

4 actions 4 updates phrasing extends openapi/microsoft-azure-devops-wiki-pages-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Azure DevOps's API. It is a proposal applied on top of the contract, not a document Azure DevOps publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/wiki/wikis/{wikiIdentifier}/pages'].get
$.paths['/wiki/wikis/{wikiIdentifier}/pages'].put
$.paths['/wiki/wikis/{wikiIdentifier}/pages'].delete

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 Azure DevOps Wiki Wiki Pages API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-wiki-pages-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['/wiki/wikis/{wikiIdentifier}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a wiki page
      effect: read
      questions:
      - How do I get the Markdown of a wiki page by its path?
      - Can I read a wiki page as it was on a certain branch?
      instructions:
      - text: Get the page at {path} in wiki {wikiIdentifier}.
        slots:
          path: query.path
          wikiIdentifier: path.wikiIdentifier
      - text: Read {path} from wiki {wikiIdentifier} at version {versionDescriptor}.
        slots:
          path: query.path
          wikiIdentifier: path.wikiIdentifier
          versionDescriptor: query.versionDescriptor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wiki/wikis/{wikiIdentifier}/pages'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a wiki page
      effect: write
      questions:
      - How do I publish a new page to a project wiki?
      - Can I add a commit message when I edit a wiki page?
      instructions:
      - text: Write {content} to page {path} in wiki {wikiIdentifier}.
        slots:
          content: requestBody.content
          path: query.path
          wikiIdentifier: path.wikiIdentifier
      - text: Save page {path} in wiki {wikiIdentifier} with content {content} and comment {comment}.
        slots:
          path: query.path
          wikiIdentifier: path.wikiIdentifier
          content: requestBody.content
          comment: query.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wiki/wikis/{wikiIdentifier}/pages'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a wiki page
      effect: destructive
      questions:
      - Can I remove a page from a wiki?
      - Is a deleted wiki page gone for good?
      instructions:
      - text: Delete page {path} from wiki {wikiIdentifier}.
        slots:
          path: query.path
          wikiIdentifier: path.wikiIdentifier
      - text: Remove wiki page {path} from {wikiIdentifier} with comment {comment}.
        slots:
          path: query.path
          wikiIdentifier: path.wikiIdentifier
          comment: query.comment
      method: generated
      generated: '2026-09-26'