Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Dialect API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/admin/api/v1/claim/dialects'].get
$.paths['/admin/api/v1/claim/dialects'].post
$.paths['/admin/api/v1/claim/dialects/{id}'].get
$.paths['/admin/api/v1/claim/dialects/{id}'].put
$.paths['/admin/api/v1/claim/dialects/{id}'].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 Admin Portal Dialect API
  version: 1.0.0
extends: openapi/strivacity-dialect-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: 5
- target: $.paths['/admin/api/v1/claim/dialects'].get
  update:
    x-apievangelist-phrasing:
      intent: List claim dialects
      effect: read
      questions:
      - Which claim dialects are defined in my tenant?
      - Can I filter claim dialects by policy tag?
      instructions:
      - text: List all claim dialects.
      - text: Find claim dialects tagged {policyTags}.
        slots:
          policyTags: query.policyTags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a claim dialect
      effect: write
      questions:
      - How do I define a new claim dialect with its own URI?
      - Can I tag a new dialect with a policy tag?
      instructions:
      - text: Create a claim dialect named {name} with URI {dialectUri}.
        slots:
          name: requestBody.name
          dialectUri: requestBody.dialectUri
      - text: Add dialect {name} at {dialectUri} tagged {policyTag}.
        slots:
          name: requestBody.name
          dialectUri: requestBody.dialectUri
          policyTag: requestBody.policyTag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a claim dialect
      effect: read
      questions:
      - How do I view one claim dialect's URI and description?
      - What does a specific dialect contain?
      instructions:
      - text: Show claim dialect {id}.
        slots:
          id: path.id
      - text: Get the URI of dialect {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a claim dialect
      effect: write
      questions:
      - How do I change the URI of an existing claim dialect?
      - Can I rename a dialect after creating it?
      instructions:
      - text: Update dialect {id} to use URI {dialectUri}.
        slots:
          id: path.id
          dialectUri: requestBody.dialectUri
      - text: Rename existing claim dialect {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a claim dialect
      effect: destructive
      questions:
      - How do I remove a claim dialect I no longer use?
      - Can I delete a dialect permanently?
      instructions:
      - text: Delete claim dialect {id}.
        slots:
          id: path.id
      - text: Remove dialect {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'