DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Sharing API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/sharing/v1/{resourceType}/{resourceId}'].get
$.paths['/sharing/v1/{resourceType}/{resourceId}'].put

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 DoiT Sharing API
  version: 1.0.0
extends: openapi/doit-sharing-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: 2
- target: $.paths['/sharing/v1/{resourceType}/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: See who can access a report, budget or alert
      effect: read
      questions:
      - Who has access to a particular Cloud Analytics report or budget?
      - Can I check the sharing permissions on an allocation or alert?
      instructions:
      - text: Show the permissions on {resourceType} {resourceId}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
      - text: List who has access to {resourceType} {resourceId}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sharing/v1/{resourceType}/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change sharing on a Cloud Analytics resource
      effect: write
      questions:
      - How do I share a report or budget with my colleagues?
      - Can I make an allocation or alert public to everyone in my organization?
      instructions:
      - text: Update the permissions on {resourceType} {resourceId} to {permissions}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
          permissions: requestBody.permissions
      - text: Set public access on {resourceType} {resourceId} to {public}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
          public: requestBody.public
      method: generated
      generated: '2026-10-01'