Encharge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Encharge Folders API

3 actions 3 updates phrasing extends openapi/encharge-folders-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Encharge's API. It is a proposal applied on top of the contract, not a document Encharge publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/folders'].post

$.paths['/folders/{id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Encharge Folders API
  version: 1.0.0
extends: openapi/encharge-folders-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: 2
- target: $.paths['/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder
      effect: write
      questions:
      - How do I create a folder to organize my items?
      - Can I set a color on a new folder?
      instructions:
      - text: Create a folder named {name} of type {folderType}.
        slots:
          name: requestBody.name
          folderType: requestBody.folderType
      - text: Create folder {id} called {name}, type {type}, folder type {folderType}.
        slots:
          id: requestBody.id
          name: requestBody.name
          type: requestBody.type
          folderType: requestBody.folderType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a folder
      effect: write
      questions:
      - How do I change an existing folder?
      - Can I edit a folder after creating it?
      instructions:
      - text: Edit folder {id}.
        slots:
          id: path.id
      - text: Update the settings of folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'