Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Account Child Attribute API

6 actions 6 updates phrasing extends openapi/strivacity-account-child-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/{parentAttributeId}/attributes'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/attributes'].put
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/attributes'].post
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/attributes/{id}'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/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 Child Attribute API
  version: 1.0.0
extends: openapi/strivacity-account-child-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/{parentAttributeId}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List child attributes of a complex attribute
      effect: read
      questions:
      - Which sub-fields belong to a complex account attribute like address?
      - How can I see the child attributes under a parent attribute?
      instructions:
      - text: List child attributes of {parentAttributeId} in identity store {identityStoreName}.
        slots:
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      - text: Show the sub-fields under complex attribute {parentAttributeId} in {identityStoreName}.
        slots:
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder child attributes of a complex attribute
      effect: write
      questions:
      - How do I change the display order of fields inside a complex attribute?
      - Can I rearrange child attributes by sending their IDs in order?
      instructions:
      - text: Reorder the child attributes of {parentAttributeId} in {identityStoreName}.
        slots:
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      - text: Put the sub-fields of complex attribute {parentAttributeId} in identity store {identityStoreName} into a new order.
        slots:
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a child attribute to a complex attribute
      effect: write
      questions:
      - How do I add a new sub-field such as postal code to a complex attribute?
      - Is there a limit on indexed attributes per identity store?
      instructions:
      - text: Create a child attribute under {parentAttributeId} in identity store {identityStoreName}.
        slots:
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      - text: Add a new sub-field to complex attribute {parentAttributeId} in {identityStoreName}.
        slots:
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/attributes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a child attribute
      effect: read
      questions:
      - How do I view the definition of one child attribute?
      - What type and path does a specific sub-field of a complex attribute have?
      instructions:
      - text: Show child attribute {id} under {parentAttributeId} in {identityStoreName}.
        slots:
          id: path.id
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      - text: Get sub-field {id} of complex attribute {parentAttributeId} in identity store {identityStoreName}.
        slots:
          id: path.id
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/attributes/{parentAttributeId}/attributes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a child attribute
      effect: write
      questions:
      - Can I change the type or name of an existing child attribute?
      - How do I edit the label of a sub-field inside a complex attribute?
      instructions:
      - text: Update child attribute {id} under {parentAttributeId} in {identityStoreName}.
        slots:
          id: path.id
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      - text: Edit the display settings of sub-field {id} of {parentAttributeId} in identity store {identityStoreName}.
        slots:
          id: path.id
          parentAttributeId: path.parentAttributeId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'