Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Claim API

6 actions 6 updates phrasing extends openapi/strivacity-claim-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/{dialectId}/claims'].get
$.paths['/admin/api/v1/claim/dialects/{dialectId}/claims'].post
$.paths['/admin/api/v1/claim/dialects/{dialectId}/claims/{id}'].get
$.paths['/admin/api/v1/claim/dialects/{dialectId}/claims/{id}'].put
$.paths['/admin/api/v1/claim/dialects/{dialectId}/claims/{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 Claim API
  version: 1.0.0
extends: openapi/strivacity-claim-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/{dialectId}/claims'].get
  update:
    x-apievangelist-phrasing:
      intent: List claims in a dialect
      effect: read
      questions:
      - Which claims are defined in a token dialect?
      - Can I search a dialect's claims by name?
      instructions:
      - text: List claims in dialect {dialect}.
        slots:
          dialect: path.dialectId
      - text: Find claims named {name} in dialect {dialect}.
        slots:
          name: query.name
          dialect: path.dialectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects/{dialectId}/claims'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a claim to a dialect
      effect: write
      questions:
      - How do I add a custom claim to tokens through a dialect?
      - Can a dialect claim map to a native claim?
      instructions:
      - text: Create claim {name} mapped to native claim {native} in dialect {dialect}.
        slots:
          name: requestBody.name
          native: requestBody.nativeClaim
          dialect: path.dialectId
      - text: Add a new claim {name} to dialect {dialect}.
        slots:
          name: requestBody.name
          dialect: path.dialectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects/{dialectId}/claims/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dialect claim
      effect: read
      questions:
      - What native claim does a dialect claim map to?
      - Can I look up a single claim in a dialect?
      instructions:
      - text: Get claim {id} in dialect {dialect}.
        slots:
          id: path.id
          dialect: path.dialectId
      - text: Show the mapping of claim {id} from dialect {dialect}.
        slots:
          id: path.id
          dialect: path.dialectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects/{dialectId}/claims/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dialect claim
      effect: write
      questions:
      - How do I rename a claim or change its native claim mapping?
      - Can I remap a claim to a different native claim?
      instructions:
      - text: Update claim {id} in dialect {dialect} to native claim {native}.
        slots:
          id: path.id
          dialect: path.dialectId
          native: requestBody.nativeClaim
      - text: Rename claim {id} in dialect {dialect} to {name}.
        slots:
          id: path.id
          dialect: path.dialectId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/dialects/{dialectId}/claims/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dialect claim
      effect: destructive
      questions:
      - How do I remove a claim from a dialect?
      - Can I delete a claim I no longer want in tokens?
      instructions:
      - text: Delete claim {id} from dialect {dialect}.
        slots:
          id: path.id
          dialect: path.dialectId
      - text: Remove claim {id} in dialect {dialect}.
        slots:
          id: path.id
          dialect: path.dialectId
      method: generated
      generated: '2026-10-01'