Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Native Claim API

6 actions 6 updates phrasing extends openapi/strivacity-native-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/native'].get
$.paths['/admin/api/v1/claim/native'].post
$.paths['/admin/api/v1/claim/native/{id}'].get
$.paths['/admin/api/v1/claim/native/{id}'].put
$.paths['/admin/api/v1/claim/native/{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 Native Claim API
  version: 1.0.0
extends: openapi/strivacity-native-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/native'].get
  update:
    x-apievangelist-phrasing:
      intent: List native claims
      effect: read
      questions:
      - What native claims are defined in my instance?
      - Can I search native claims by name?
      instructions:
      - text: List native claims.
      - text: Find native claims named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/native'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a native claim
      effect: write
      questions:
      - How do I define a new native claim for tokens?
      - Can a native claim be read-only or tied to a dialect URI?
      instructions:
      - text: Create native claim {name} displayed as {displayName}.
        slots:
          name: requestBody.name
          displayName: requestBody.displayName
      - text: Create read-only ({readonly}) native claim {name} with display name {displayName}.
        slots:
          readonly: requestBody.readonly
          name: requestBody.name
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/native/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a native claim
      effect: read
      questions:
      - Can I view the details of one native claim?
      - What dialect URI does a specific native claim use?
      instructions:
      - text: Get native claim {id}.
        slots:
          id: path.id
      - text: Show the definition of native claim {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/native/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a native claim
      effect: write
      questions:
      - How do I change the display name of a native claim?
      - Can I make an existing native claim read-only?
      instructions:
      - text: Update native claim {id} display name to {displayName}.
        slots:
          id: path.id
          displayName: requestBody.displayName
      - text: Set read-only to {readonly} on native claim {id}.
        slots:
          readonly: requestBody.readonly
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/claim/native/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a native claim
      effect: destructive
      questions:
      - Why can't I delete a native claim that an account attribute uses?
      - How do I remove a native claim?
      instructions:
      - text: Delete native claim {id}.
        slots:
          id: path.id
      - text: Remove the unused native claim {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'