Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Wiki Wikis API

6 actions 6 updates phrasing extends openapi/microsoft-azure-devops-wikis-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 6

$.info
$.paths['/wiki/wikis'].get
$.paths['/wiki/wikis'].post
$.paths['/wiki/wikis/{wikiIdentifier}'].get
$.paths['/wiki/wikis/{wikiIdentifier}'].delete
$.paths['/wiki/wikis/{wikiIdentifier}'].patch

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 Wikis API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-wikis-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: 5
- target: $.paths['/wiki/wikis'].get
  update:
    x-apievangelist-phrasing:
      intent: List wikis in a project
      effect: read
      questions:
      - What wikis does my Azure DevOps project have?
      - Are there code wikis in the project besides the project wiki?
      instructions:
      - text: List the wikis in the project.
      - text: Show every project and code wiki, using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wiki/wikis'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a wiki
      effect: write
      questions:
      - How do I publish a folder from a repo as a code wiki?
      - Can I create a project wiki for a project that has none?
      instructions:
      - text: Create a {type} wiki named {name} in project {projectId}.
        slots:
          type: requestBody.type
          name: requestBody.name
          projectId: requestBody.projectId
      - text: Create {type} wiki {name} in {projectId} from repository {repositoryId} at path {mappedPath}.
        slots:
          type: requestBody.type
          name: requestBody.name
          projectId: requestBody.projectId
          repositoryId: requestBody.repositoryId
          mappedPath: requestBody.mappedPath
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wiki/wikis/{wikiIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a wiki
      effect: read
      questions:
      - Which repository and mapped path back a given wiki?
      - Can I look up one wiki by its name?
      instructions:
      - text: Show wiki {wikiIdentifier}.
        slots:
          wikiIdentifier: path.wikiIdentifier
      - text: Get the backing repository of wiki {wikiIdentifier}.
        slots:
          wikiIdentifier: path.wikiIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wiki/wikis/{wikiIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a wiki
      effect: destructive
      questions:
      - Does deleting a project wiki also delete its Git repository?
      - Can I unpublish a code wiki without losing the repository?
      instructions:
      - text: Delete wiki {wikiIdentifier}.
        slots:
          wikiIdentifier: path.wikiIdentifier
      - text: Unpublish code wiki {wikiIdentifier}.
        slots:
          wikiIdentifier: path.wikiIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wiki/wikis/{wikiIdentifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a code wiki's branch
      effect: write
      questions:
      - How do I point a code wiki at a renamed main branch?
      - Can I change which branch versions a code wiki publishes?
      instructions:
      - text: Set the versions of wiki {wikiIdentifier} to {versions}.
        slots:
          wikiIdentifier: path.wikiIdentifier
          versions: requestBody.versions
      - text: Switch code wiki {wikiIdentifier} to branch {versions}.
        slots:
          wikiIdentifier: path.wikiIdentifier
          versions: requestBody.versions
      method: generated
      generated: '2026-09-26'