Windmill API — resource

naftiko: 1.0.0-alpha2
info:
  label: Windmill API — resource
  description: 'Windmill API — resource. 23 operations. Lead operation: Query Resource Types by Similarity. Self-contained
    Naftiko capability covering one Windmill business surface.'
  tags:
  - Windmill
  - resource
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WINDMILL_API_KEY: WINDMILL_API_KEY
capability:
  consumes:
  - type: http
    namespace: windmill-resource
    baseUri: ''
    description: Windmill API — resource business capability. Self-contained, no shared references.
    resources:
    - name: w-workspace-embeddings-query_resource_types
      path: /w/{workspace}/embeddings/query_resource_types
      operations:
      - name: queryresourcetypes
        method: GET
        description: Query Resource Types by Similarity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: text
          in: query
          type: string
          description: query text
          required: true
        - name: limit
          in: query
          type: number
          description: query limit
    - name: w-workspace-resources-create
      path: /w/{workspace}/resources/create
      operations:
      - name: createresource
        method: POST
        description: Create Resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: update_if_exists
          in: query
          type: boolean
          description: update the resource if it already exists (default false)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-resources-delete-path
      path: /w/{workspace}/resources/delete/{path}
      operations:
      - name: deleteresource
        method: DELETE
        description: Delete Resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-delete_bulk
      path: /w/{workspace}/resources/delete_bulk
      operations:
      - name: deleteresourcesbulk
        method: DELETE
        description: Delete Resources in Bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-resources-exists-path
      path: /w/{workspace}/resources/exists/{path}
      operations:
      - name: existsresource
        method: GET
        description: Does Resource Exists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-file_resource_type_to_file_ext_map
      path: /w/{workspace}/resources/file_resource_type_to_file_ext_map
      operations:
      - name: fileresourcetypetofileextmap
        method: GET
        description: Get Map from Resource Type to Format Extension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-get-path
      path: /w/{workspace}/resources/get/{path}
      operations:
      - name: getresource
        method: GET
        description: Get Resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-get_value-path
      path: /w/{workspace}/resources/get_value/{path}
      operations:
      - name: getresourcevalue
        method: GET
        description: Get Resource Value
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-get_value_interpolated-path
      path: /w/{workspace}/resources/get_value_interpolated/{path}
      operations:
      - name: getresourcevalueinterpolated
        method: GET
        description: Get Resource Interpolated (variables and Resources are Fully Unrolled)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: job_id
          in: query
          type: string
          description: job id
        - name: allow_cache
          in: query
          type: boolean
          description: allow getting a cached value for improved performance
    - name: w-workspace-resources-git_commit_hash-path
      path: /w/{workspace}/resources/git_commit_hash/{path}
      operations:
      - name: getgitcommithash
        method: GET
        description: Get Git Repository Latest Commit Hash
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: git_ssh_identity
          in: query
          type: string
    - name: w-workspace-resources-list
      path: /w/{workspace}/resources/list
      operations:
      - name: listresource
        method: GET
        description: List Resources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resource_type
          in: query
          type: string
          description: resource_types to list from, separated by ',',
        - name: resource_type_exclude
          in: query
          type: string
          description: resource_types to not list from, separated by ',',
        - name: path_start
          in: query
          type: string
          description: filter resources by path prefix
        - name: path
          in: query
          type: string
          description: exact path match filter
        - name: description
          in: query
          type: string
          description: pattern match filter for description field (case-insensitive)
        - name: value
          in: query
          type: string
          description: JSONB subset match filter using base64 encoded JSON
        - name: broad_filter
          in: query
          type: string
          description: broad search across multiple fields (case-insensitive substring match)
        - name: label
          in: query
          type: string
          description: Filter by label
    - name: w-workspace-resources-list_names-name
      path: /w/{workspace}/resources/list_names/{name}
      operations:
      - name: listresourcenames
        method: GET
        description: List Resource Names
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-list_search
      path: /w/{workspace}/resources/list_search
      operations:
      - name: listsearchresource
        method: GET
        description: List Resources for Search
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-mcp_tools-path
      path: /w/{workspace}/resources/mcp_tools/{path}
      operations:
      - name: getmcptools
        method: GET
        description: Get MCP Tools from Resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-type-create
      path: /w/{workspace}/resources/type/create
      operations:
      - name: createresourcetype
        method: POST
        description: Create Resource_type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-resources-type-delete-path
      path: /w/{workspace}/resources/type/delete/{path}
      operations:
      - name: deleteresourcetype
        method: DELETE
        description: Delete Resource_type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-type-exists-path
      path: /w/{workspace}/resources/type/exists/{path}
      operations:
      - name: existsresourcetype
        method: GET
        description: Does Resource_type Exists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-type-get-path
      path: /w/{workspace}/resources/type/get/{path}
      operations:
      - name: getresourcetype
        method: GET
        description: Get Resource_type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-type-list
      path: /w/{workspace}/resources/type/list
      operations:
      - name: listresourcetype
        method: GET
        description: List Resource_types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-type-listnames
      path: /w/{workspace}/resources/type/listnames
      operations:
      - name: listresourcetypenames
        method: GET
        description: List Resource_types Names
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-resources-type-update-path
      path: /w/{workspace}/resources/type/update/{path}
      operations:
      - name: updateresourcetype
        method: POST
        description: Update Resource_type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-resources-update-path
      path: /w/{workspace}/resources/update/{path}
      operations:
      - name: updateresource
        method: POST
        description: Update Resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-resources-update_value-path
      path: /w/{workspace}/resources/update_value/{path}
      operations:
      - name: updateresourcevalue
        method: POST
        description: Update Resource Value
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.WINDMILL_API_KEY}}'
  exposes:
  - type: rest
    namespace: windmill-resource-rest
    port: 8080
    description: REST adapter for Windmill API — resource. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/w/{workspace}/embeddings/query-resource-types
      name: w-workspace-embeddings-query-resource-types
      description: REST surface for w-workspace-embeddings-query_resource_types.
      operations:
      - method: GET
        name: queryresourcetypes
        description: Query Resource Types by Similarity
        call: windmill-resource.queryresourcetypes
        with:
          text: rest.text
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/create
      name: w-workspace-resources-create
      description: REST surface for w-workspace-resources-create.
      operations:
      - method: POST
        name: createresource
        description: Create Resource
        call: windmill-resource.createresource
        with:
          update_if_exists: rest.update_if_exists
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/delete/{path}
      name: w-workspace-resources-delete-path
      description: REST surface for w-workspace-resources-delete-path.
      operations:
      - method: DELETE
        name: deleteresource
        description: Delete Resource
        call: windmill-resource.deleteresource
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/delete-bulk
      name: w-workspace-resources-delete-bulk
      description: REST surface for w-workspace-resources-delete_bulk.
      operations:
      - method: DELETE
        name: deleteresourcesbulk
        description: Delete Resources in Bulk
        call: windmill-resource.deleteresourcesbulk
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/exists/{path}
      name: w-workspace-resources-exists-path
      description: REST surface for w-workspace-resources-exists-path.
      operations:
      - method: GET
        name: existsresource
        description: Does Resource Exists
        call: windmill-resource.existsresource
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/file-resource-type-to-file-ext-map
      name: w-workspace-resources-file-resource-type-to-file-ext-map
      description: REST surface for w-workspace-resources-file_resource_type_to_file_ext_map.
      operations:
      - method: GET
        name: fileresourcetypetofileextmap
        description: Get Map from Resource Type to Format Extension
        call: windmill-resource.fileresourcetypetofileextmap
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/get/{path}
      name: w-workspace-resources-get-path
      description: REST surface for w-workspace-resources-get-path.
      operations:
      - method: GET
        name: getresource
        description: Get Resource
        call: windmill-resource.getresource
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/get-value/{path}
      name: w-workspace-resources-get-value-path
      description: REST surface for w-workspace-resources-get_value-path.
      operations:
      - method: GET
        name: getresourcevalue
        description: Get Resource Value
        call: windmill-resource.getresourcevalue
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/get-value-interpolated/{path}
      name: w-workspace-resources-get-value-interpolated-path
      description: REST surface for w-workspace-resources-get_value_interpolated-path.
      operations:
      - method: GET
        name: getresourcevalueinterpolated
        description: Get Resource Interpolated (variables and Resources are Fully Unrolled)
        call: windmill-resource.getresourcevalueinterpolated
        with:
          job_id: rest.job_id
          allow_cache: rest.allow_cache
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/git-commit-hash/{path}
      name: w-workspace-resources-git-commit-hash-path
      description: REST surface for w-workspace-resources-git_commit_hash-path.
      operations:
      - method: GET
        name: getgitcommithash
        description: Get Git Repository Latest Commit Hash
        call: windmill-resource.getgitcommithash
        with:
          git_ssh_identity: rest.git_ssh_identity
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/list
      name: w-workspace-resources-list
      description: REST surface for w-workspace-resources-list.
      operations:
      - method: GET
        name: listresource
        description: List Resources
        call: windmill-resource.listresource
        with:
          resource_type: rest.resource_type
          resource_type_exclude: rest.resource_type_exclude
          path_start: rest.path_start
          path: rest.path
          description: rest.description
          value: rest.value
          broad_filter: rest.broad_filter
          label: rest.label
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/list-names/{name}
      name: w-workspace-resources-list-names-name
      description: REST surface for w-workspace-resources-list_names-name.
      operations:
      - method: GET
        name: listresourcenames
        description: List Resource Names
        call: windmill-resource.listresourcenames
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/list-search
      name: w-workspace-resources-list-search
      description: REST surface for w-workspace-resources-list_search.
      operations:
      - method: GET
        name: listsearchresource
        description: List Resources for Search
        call: windmill-resource.listsearchresource
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/mcp-tools/{path}
      name: w-workspace-resources-mcp-tools-path
      description: REST surface for w-workspace-resources-mcp_tools-path.
      operations:
      - method: GET
        name: getmcptools
        description: Get MCP Tools from Resource
        call: windmill-resource.getmcptools
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/type/create
      name: w-workspace-resources-type-create
      description: REST surface for w-workspace-resources-type-create.
      operations:
      - method: POST
        name: createresourcetype
        description: Create Resource_type
        call: windmill-resource.createresourcetype
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/type/delete/{path}
      name: w-workspace-resources-type-delete-path
      description: REST surface for w-workspace-resources-type-delete-path.
      operations:
      - method: DELETE
        name: deleteresourcetype
        description: Delete Resource_type
        call: windmill-resource.deleteresourcetype
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/type/exists/{path}
      name: w-workspace-resources-type-exists-path
      description: REST surface for w-workspace-resources-type-exists-path.
      operations:
      - method: GET
        name: existsresourcetype
        description: Does Resource_type Exists
        call: windmill-resource.existsresourcetype
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/type/get/{path}
      name: w-workspace-resources-type-get-path
      description: REST surface for w-workspace-resources-type-get-path.
      operations:
      - method: GET
        name: getresourcetype
        description: Get Resource_type
        call: windmill-resource.getresourcetype
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/type/list
      name: w-workspace-resources-type-list
      description: REST surface for w-workspace-resources-type-list.
      operations:
      - method: GET
        name: listresourcetype
        description: List Resource_types
        call: windmill-resource.listresourcetype
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/type/listnames
      name: w-workspace-resources-type-listnames
      description: REST surface for w-workspace-resources-type-listnames.
      operations:
      - method: GET
        name: listresourcetypenames
        description: List Resource_types Names
        call: windmill-resource.listresourcetypenames
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/type/update/{path}
      name: w-workspace-resources-type-update-path
      description: REST surface for w-workspace-resources-type-update-path.
      operations:
      - method: POST
        name: updateresourcetype
        description: Update Resource_type
        call: windmill-resource.updateresourcetype
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/update/{path}
      name: w-workspace-resources-update-path
      description: REST surface for w-workspace-resources-update-path.
      operations:
      - method: POST
        name: updateresource
        description: Update Resource
        call: windmill-resource.updateresource
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/resources/update-value/{path}
      name: w-workspace-resources-update-value-path
      description: REST surface for w-workspace-resources-update_value-path.
      operations:
      - method: POST
        name: updateresourcevalue
        description: Update Resource Value
        call: windmill-resource.updateresourcevalue
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: windmill-resource-mcp
    port: 9090
    transport: http
    description: MCP adapter for Windmill API — resource. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: query-resource-types-similarity
      description: Query Resource Types by Similarity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.queryresourcetypes
      with:
        text: tools.text
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-resource
      description: Create Resource
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-resource.createresource
      with:
        update_if_exists: tools.update_if_exists
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-resource
      description: Delete Resource
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: windmill-resource.deleteresource
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-resources-bulk
      description: Delete Resources in Bulk
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: windmill-resource.deleteresourcesbulk
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: does-resource-exists
      description: Does Resource Exists
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.existsresource
      outputParameters:
      - type: object
        mapping: $.
    - name: get-map-resource-type-format
      description: Get Map from Resource Type to Format Extension
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.fileresourcetypetofileextmap
      outputParameters:
      - type: object
        mapping: $.
    - name: get-resource
      description: Get Resource
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.getresource
      outputParameters:
      - type: object
        mapping: $.
    - name: get-resource-value
      description: Get Resource Value
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.getresourcevalue
      outputParameters:
      - type: object
        mapping: $.
    - name: get-resource-interpolated-variables-and
      description: Get Resource Interpolated (variables and Resources are Fully Unrolled)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.getresourcevalueinterpolated
      with:
        job_id: tools.job_id
        allow_cache: tools.allow_cache
      outputParameters:
      - type: object
        mapping: $.
    - name: get-git-repository-latest-commit
      description: Get Git Repository Latest Commit Hash
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.getgitcommithash
      with:
        git_ssh_identity: tools.git_ssh_identity
      outputParameters:
      - type: object
        mapping: $.
    - name: list-resources
      description: List Resources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.listresource
      with:
        resource_type: tools.resource_type
        resource_type_exclude: tools.resource_type_exclude
        path_start: tools.path_start
        path: tools.path
        description: tools.description
        value: tools.value
        broad_filter: tools.broad_filter
        label: tools.label
      outputParameters:
      - type: object
        mapping: $.
    - name: list-resource-names
      description: List Resource Names
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.listresourcenames
      outputParameters:
      - type: object
        mapping: $.
    - name: list-resources-search
      description: List Resources for Search
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.listsearchresource
      outputParameters:
      - type: object
        mapping: $.
    - name: get-mcp-tools-resource
      description: Get MCP Tools from Resource
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.getmcptools
      outputParameters:
      - type: object
        mapping: $.
    - name: create-resource-type
      description: Create Resource_type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-resource.createresourcetype
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-resource-type
      description: Delete Resource_type
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: windmill-resource.deleteresourcetype
      outputParameters:
      - type: object
        mapping: $.
    - name: does-resource-type-exists
      description: Does Resource_type Exists
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.existsresourcetype
      outputParameters:
      - type: object
        mapping: $.
    - name: get-resource-type
      description: Get Resource_type
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.getresourcetype
      outputParameters:
      - type: object
        mapping: $.
    - name: list-resource-types
      description: List Resource_types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.listresourcetype
      outputParameters:
      - type: object
        mapping: $.
    - name: list-resource-types-names
      description: List Resource_types Names
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-resource.listresourcetypenames
      outputParameters:
      - type: object
        mapping: $.
    - name: update-resource-type
      description: Update Resource_type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-resource.updateresourcetype
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-resource
      description: Update Resource
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-resource.updateresource
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-resource-value
      description: Update Resource Value
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-resource.updateresourcevalue
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.