Appsmith · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appsmith Applications API

4 actions 4 updates phrasing extends openapi/appsmith-applications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Appsmith's API. It is a proposal applied on top of the contract, not a document Appsmith publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/applications'].get
$.paths['/applications'].post
$.paths['/applications/{applicationId}'].get

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 Appsmith Applications API
  version: 1.0.0
extends: openapi/appsmith-applications-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: 3
- target: $.paths['/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List low-code applications
      effect: read
      questions:
      - Which apps have we built in Appsmith so far?
      - Can I see only the applications that live in one particular workspace?
      - How do I get an inventory of all our internal tool apps?
      instructions:
      - text: List all of my low-code applications.
      - text: Show me the applications in workspace {workspaceId}.
        slots:
          workspaceId: query.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new low-code application
      effect: write
      questions:
      - How do I start a brand-new internal tool app programmatically?
      - Can I choose which workspace a new application is created in?
      - What do I need to provide to spin up a new low-code app?
      instructions:
      - text: Create a new application called {name}.
        slots:
          name: requestBody.name
      - text: Create an app named {name} in workspace {workspaceId}.
        slots:
          name: requestBody.name
          workspaceId: requestBody.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{applicationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one application
      effect: read
      questions:
      - How can I look up the details of a single app when I know its ID?
      - What information comes back about one specific low-code application?
      instructions:
      - text: Get the details of application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Fetch app {applicationId} so I can see its settings.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-10-01'