Windmill

Windmill draft API

The draft API from Windmill — 2 operation(s) for draft.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.windmill.dev/docs/intro
📖
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
📖
Authentication
https://www.windmill.dev/docs/core_concepts/authentification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/openapi/windmill-draft-api-openapi.yml

Other Resources

🔗
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
🔗
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
🔗
CLI
https://www.windmill.dev/docs/advanced/cli
🔗
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
🔗
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
🔗
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/rules/windmill-api-rules.yml

OpenAPI Specification

windmill-draft-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  version: 1.694.0
  title: Windmill admin draft API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: draft
paths:
  /w/{workspace}/drafts/create:
    post:
      summary: Create Draft
      operationId: createDraft
      tags:
      - draft
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                typ:
                  type: string
                  enum:
                  - flow
                  - script
                  - app
                value: {}
              required:
              - path
              - typ
              - enum
      responses:
        '201':
          description: draft created
          content:
            text/plain:
              schema:
                type: string
  /w/{workspace}/drafts/delete/{kind}/{path}:
    delete:
      summary: Delete Draft
      operationId: deleteDraft
      tags:
      - draft
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: kind
        in: path
        required: true
        schema:
          type: string
          enum:
          - script
          - flow
          - app
      - $ref: '#/components/parameters/ScriptPath'
      responses:
        '200':
          description: draft deleted
          content:
            text/plain:
              schema:
                type: string
components:
  parameters:
    ScriptPath:
      name: path
      in: path
      required: true
      schema:
        type: string
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: token
externalDocs:
  description: documentation portal
  url: https://windmill.dev