Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Files API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/files/upload/'].post

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 Close Files API
  version: 1.0.0
extends: openapi/close-files-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: 1
- target: $.paths['/files/upload/'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a signed upload for a file
      effect: write
      questions:
      - How do I upload a file so I can attach it to a note or email?
      - What do I need before uploading an attachment to storage?
      instructions:
      - text: Generate an upload for {filename} of type {content_type}.
        slots:
          filename: requestBody.filename
          content_type: requestBody.content_type
      - text: Prepare a signed S3 upload for file {filename} ({content_type}).
        slots:
          filename: requestBody.filename
          content_type: requestBody.content_type
      method: generated
      generated: '2026-09-26'