Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Application API

6 actions 6 updates phrasing extends openapi/strivacity-application-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/v2/applications'].get
$.paths['/admin/api/v2/applications'].post
$.paths['/admin/api/v2/applications/{id}'].get
$.paths['/admin/api/v2/applications/{id}'].put
$.paths['/admin/api/v2/applications/{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 Application API
  version: 1.0.0
extends: openapi/strivacity-application-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/v2/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications
      effect: read
      questions:
      - What applications are configured in my Strivacity instance?
      - Can I find an application by its OAuth2 client ID?
      instructions:
      - text: List applications.
      - text: Find the application with OAuth2 client ID {oauth2ClientId}.
        slots:
          oauth2ClientId: query.oauth2ClientId
      - text: List applications tagged {policyTags}.
        slots:
          policyTags: query.policyTags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application
      effect: write
      questions:
      - How do I register a new application with its identity store and login providers?
      - Can I set session max age and inactivity timeout when creating an application?
      instructions:
      - text: Create application {name} of type {type} using identity store {identityStore}.
        slots:
          name: requestBody.name
          type: requestBody.type
          identityStore: requestBody.identityStore
      - text: Create application {name} with login providers {loginProviders} and policies {policies}.
        slots:
          name: requestBody.name
          loginProviders: requestBody.loginProviders
          policies: requestBody.policies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application
      effect: read
      questions:
      - Can I view the full configuration of one application?
      - Which policies and login providers does a specific application use?
      instructions:
      - text: Get application {id}.
        slots:
          id: path.id
      - text: Show the configuration of application {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an application
      effect: write
      questions:
      - Can I change an application's type after it's created?
      - How do I change the session max age of an existing application?
      instructions:
      - text: Update application {id} with session max age {sessionMaxAgeMinutes} minutes.
        slots:
          id: path.id
          sessionMaxAgeMinutes: requestBody.sessionMaxAgeMinutes
      - text: Change the login providers of application {id} to {loginProviders}.
        slots:
          id: path.id
          loginProviders: requestBody.loginProviders
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application
      effect: destructive
      questions:
      - How do I delete an application I no longer need?
      - Is deleting an application permanent?
      instructions:
      - text: Delete application {id}.
        slots:
          id: path.id
      - text: Remove application {id} from the instance.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'