Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Vendor Types API

5 actions 5 updates phrasing extends openapi/drata-vendor-types-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/vendor-types'].get

$.paths['/vendor-types'].post

$.paths['/vendor-types/{vendorTypeId}'].put

$.paths['/vendor-types/{vendorTypeId}'].delete

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 Drata Vendor Types API
  version: 1.0.0
extends: openapi/drata-vendor-types-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: 4
- target: $.paths['/vendor-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List vendor types
      effect: read
      questions:
      - Which vendor types are configured for our account?
      - Can I page through all our custom vendor types?
      instructions:
      - text: List vendor types.
      - text: Show vendor types, {size} per page.
        slots:
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vendor-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a vendor type
      effect: write
      questions:
      - How do I add a new vendor type?
      - Can I define my own category of vendor?
      instructions:
      - text: Create a vendor type named {name}.
        slots:
          name: requestBody.name
      - text: Add {name} as a new vendor type.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vendor-types/{vendorTypeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a vendor type
      effect: write
      questions:
      - How do I rename an existing vendor type?
      - Can I change the label of a vendor type we already use?
      instructions:
      - text: Rename vendor type {vendorTypeId} to {name}.
        slots:
          vendorTypeId: path.vendorTypeId
          name: requestBody.name
      - text: Change the name of vendor type {vendorTypeId} to {name}.
        slots:
          vendorTypeId: path.vendorTypeId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vendor-types/{vendorTypeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vendor type
      effect: destructive
      questions:
      - Can I delete a vendor type we no longer need?
      - Is removing a vendor type a soft delete?
      instructions:
      - text: Delete vendor type {vendorTypeId}.
        slots:
          vendorTypeId: path.vendorTypeId
      - text: Remove the vendor type {vendorTypeId} from our list.
        slots:
          vendorTypeId: path.vendorTypeId
      method: generated
      generated: '2026-09-26'