Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Account Attribute API

6 actions 6 updates phrasing extends openapi/strivacity-account-attribute-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/identityStores/{identityStoreName}/attributes'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes'].put
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes'].post
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{id}'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{id}'].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 Admin Portal Account Attribute API
  version: 1.0.0
extends: openapi/strivacity-account-attribute-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/identityStores/{identityStoreName}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List account attributes
      effect: read
      questions:
      - What account attributes are defined in an identity store?
      - Can I see the profile fields configured for customer accounts?
      instructions:
      - text: List attributes of identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Show the account fields defined in {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder account attributes
      effect: write
      questions:
      - How do I change the display order of account attributes?
      - Can I rearrange attributes in an identity store?
      instructions:
      - text: Reorder the attributes of identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Put {identityStoreName}'s account attributes in a new order.
        slots:
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account attribute
      effect: write
      questions:
      - How do I add a custom profile field to customer accounts?
      - Is there a limit on how many indexed attributes an identity store can have?
      instructions:
      - text: Create a new attribute in identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Add a custom account field to {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account attribute
      effect: read
      questions:
      - Can I view the definition of one account attribute?
      - What type and path does a specific attribute have?
      instructions:
      - text: Get attribute {id} in identity store {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      - text: Show the definition of {identityStoreName} attribute {id}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account attribute
      effect: write
      questions:
      - Which parts of an account attribute can't be changed after creation?
      - How do I edit an existing account attribute?
      instructions:
      - text: Update attribute {id} in identity store {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      - text: Edit {identityStoreName} account attribute {id}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'