Windmill

Windmill npm_proxy API

The npm_proxy API from Windmill — 4 operation(s) for npm_proxy.

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-npm-proxy-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-npm-proxy-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  version: 1.694.0
  title: Windmill admin npm_proxy 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: npm_proxy
paths:
  /w/{workspace}/npm_proxy/metadata/{package}:
    get:
      summary: Get Npm Package Metadata from Private Registry
      operationId: getNpmPackageMetadata
      tags:
      - npm_proxy
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: package
        description: npm package name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: package metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  tags:
                    type: object
                    additionalProperties:
                      type: string
                  versions:
                    type: array
                    items:
                      type: string
  /w/{workspace}/npm_proxy/resolve/{package}:
    get:
      summary: Resolve Npm Package Version from Private Registry
      operationId: resolveNpmPackageVersion
      tags:
      - npm_proxy
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: package
        description: npm package name
        in: path
        required: true
        schema:
          type: string
      - name: tag
        description: version tag or reference
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: resolved version
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string
                    nullable: true
  /w/{workspace}/npm_proxy/filetree/{package}/{version}:
    get:
      summary: Get Npm Package File Tree from Private Registry
      operationId: getNpmPackageFiletree
      tags:
      - npm_proxy
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: package
        description: npm package name
        in: path
        required: true
        schema:
          type: string
      - name: version
        description: package version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: package file tree
          content:
            application/json:
              schema:
                type: object
                properties:
                  default:
                    type: string
                  files:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
  /w/{workspace}/npm_proxy/file/{package}/{version}/{filepath}:
    get:
      summary: Get Specific File from Npm Package in Private Registry
      operationId: getNpmPackageFile
      tags:
      - npm_proxy
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: package
        description: npm package name
        in: path
        required: true
        schema:
          type: string
      - name: version
        description: package version
        in: path
        required: true
        schema:
          type: string
      - name: filepath
        description: file path within package
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: file content
          content:
            text/plain:
              schema:
                type: string
components:
  parameters:
    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