API Evangelist conversational phrasing for Things Stack — Application Server Application Registry API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Things Stack — Application Server Application Registry API
  version: 1.0.0
extends: openapi/the-things-network-applicationregistry-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications I can access
      effect: read
      questions:
      - Which Things Stack applications can I see with my credentials?
      - Can I include recently deleted applications when listing them?
      instructions:
      - text: List all applications I have access to.
      - text: List applications where user {user_id} is a direct collaborator.
        slots:
          user_id: query.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{application.ids.application_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an application's settings
      effect: write
      questions:
      - How do I rename an application or change its description?
      - Can I update only certain fields of an application using a field mask?
      instructions:
      - text: Update application {application_id} with the fields in {field_mask}.
        slots:
          application_id: path.application.ids.application_id
          field_mask: requestBody.field_mask
      - text: Change application {application_id} to {application}.
        slots:
          application_id: path.application.ids.application_id
          application: requestBody.application
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{application_ids.application_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application
      effect: read
      questions:
      - What are the details of a specific application?
      - Can I choose which fields come back when fetching one application?
      instructions:
      - text: Show application {application_id}.
        slots:
          application_id: path.application_ids.application_id
      - text: Get only the {field_mask} of application {application_id}.
        slots:
          field_mask: query.field_mask
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{application_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application
      effect: destructive
      questions:
      - How do I delete an application, and do I need to remove its devices first?
      - Does deleting an application free up its ID for reuse?
      instructions:
      - text: Delete application {application_id}.
        slots:
          application_id: path.application_id
      - text: Soft-delete application {application_id} after its devices are removed.
        slots:
          application_id: path.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{application_id}/dev-eui'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a DevEUI for a device in an application
      effect: write
      questions:
      - Can the network assign a DevEUI from its address block for a new device in my app?
      - Is there a limit on how many DevEUIs one application can be issued?
      instructions:
      - text: Issue a new DevEUI for application {application_id}.
        slots:
          application_id: path.application_id
      - text: Request a DevEUI from the address block for a device in application {application_id}.
        slots:
          application_id: path.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{application_id}/purge'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently purge an application
      effect: destructive
      questions:
      - How do I purge an application so its ID can be reused?
      - What is the difference between purging an application and a normal delete?
      instructions:
      - text: Purge application {application_id} permanently.
        slots:
          application_id: path.application_id
      - text: Release application ID {application_id} for reuse by purging it.
        slots:
          application_id: path.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{application_id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted application
      effect: write
      questions:
      - Can I bring back an application I deleted by mistake?
      - How long after deletion is an application still restorable?
      instructions:
      - text: Restore deleted application {application_id}.
        slots:
          application_id: path.application_id
      - text: Undelete application {application_id}.
        slots:
          application_id: path.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{collaborator.organization_ids.organization_id}/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's applications
      effect: read
      questions:
      - Which applications does my organization collaborate on?
      - Can I list an organization's deleted applications too?
      instructions:
      - text: List applications for organization {organization_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
      - text: 'List organization {organization_id}''s applications including deleted ones: {deleted}.'
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{collaborator.organization_ids.organization_id}/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application under an organization
      effect: write
      questions:
      - How do I create a new application owned by an organization?
      - Does the organization get full rights on the application it creates?
      instructions:
      - text: Create application {application} under organization {organization_id}.
        slots:
          application: requestBody.application
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Set up a new app {application} owned by organization {organization_id}.
        slots:
          application: requestBody.application
          organization_id: path.collaborator.organization_ids.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{collaborator.user_ids.user_id}/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's applications
      effect: read
      questions:
      - What applications is a given user a direct collaborator on?
      - Can I see a particular user's applications sorted and paginated?
      instructions:
      - text: List applications for user {user_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
      - text: Show the first {limit} applications of user {user_id}.
        slots:
          limit: query.limit
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{collaborator.user_ids.user_id}/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application under a user
      effect: write
      questions:
      - How do I create a personal application owned by my user account?
      - Will I automatically be the first collaborator on an application I create for myself?
      instructions:
      - text: Create application {application} under user {user_id}.
        slots:
          application: requestBody.application
          user_id: path.collaborator.user_ids.user_id
      - text: Set up a new app {application} owned by my user {user_id}.
        slots:
          application: requestBody.application
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'