aspera-cli 4.27.0 → 4.27.2

data/lib/aspera/cli/options.schema.yaml

@@ -29,6 +29,69 @@ components:
           type: boolean
           description: Show passwords and secrets in logs.
           default: false
+    McpServerOptions:
+      type: object
+      description: MCP server configuration for the `mcp server` command.
+      properties:
+        transport:
+          type: string
+          description: Transport used by the MCP server.
+          enum: [stdio, http]
+          default: stdio
+        extra_args:
+          type: array
+          description: Flags prepended to every `ascli` command.
+          items:
+            type: string
+        max_text_bytes:
+          type: integer
+          description: Maximum number of bytes for JSON text content in list results.
+          default: 100000
+        max_line_bytes:
+          type: integer
+          description: Maximum JSON frame size for stdio transport.
+          default: 4194304
+        port:
+          type: integer
+          description: TCP port for HTTP transport.
+          default: 3000
+        bind:
+          type: string
+          description: Bind address for HTTP transport.
+          default: 127.0.0.1
+        stateless:
+          type: boolean
+          description: Run HTTP transport in stateless mode.
+          default: false
+        allowed_origins:
+          type: array
+          description: Allowed HTTP origin values.
+          items:
+            type: string
+        allowed_hosts:
+          type: array
+          description: Allowed HTTP host values.
+          items:
+            type: string
+        session_idle_timeout:
+          type: integer
+          description: HTTP session idle timeout in seconds.
+        max_sessions:
+          type: integer
+          description: Maximum number of HTTP sessions.
+        instructions:
+          type: string
+          description: Instructions shown to the AI client.
+        description:
+          type: string
+          description: Description advertised by the MCP server.
+        protocol_version:
+          type: string
+          description: MCP protocol version, for example `2024-11-05`.
+        validate_tool_call_arguments:
+          type: boolean
+          description: Validate MCP tool call arguments.
+          default: true
     DirectAgentOptions:
       type: object
       description: Parameters for the `ascp` transfer agent.
@@ -354,6 +417,38 @@ components:
         name:
           type: string
           description: Name of the keychain to use.
+    VaultOnePasswordOptions:
+      type: object
+      description: 1Password secret store (Connect REST API or CLI).
+      required:
+        - type
+        - source
+      properties:
+        type:
+          type: string
+          description: Vault type selector.
+          enum: [1password]
+        source:
+          type: string
+          description: Backend source. Use `api` for the Connect REST API, `cli` for the `op` CLI.
+          enum: [api, cli]
+          default: api
+        url:
+          type: string
+          description: Base URL of the 1Password Connect server (required when `source` is `api`).
+          example: "http://localhost:8080"
+        vault_id:
+          type: string
+          description: ID of the 1Password vault to use (required when `source` is `api`).
+        token:
+          type: string
+          description: Bearer token for the Connect API (required when `source` is `api`). Defaults to the value of `vault_password`.
+        vault:
+          type: string
+          description: Name or ID of the 1Password vault to use with the CLI (used when `source` is `cli`). Uses the default vault if omitted.
+        account:
+          type: string
+          description: Account shorthand for `op` (used when `source` is `cli`). Uses the default account if omitted.
     VaultFileOptions:
       type: object
       description: Encrypted file secret store.
@@ -370,6 +465,27 @@ components:
             Path to the encrypted vault file.
             Relative paths are resolved from the configuration folder.
           default: vault.bin
+    VaultSecret:
+      type: object
+      description: Secret entry in the vault
+      required:
+        - label
+      properties:
+        label:
+          type: string
+          description: Unique identifier for this secret entry
+        username:
+          type: string
+          description: Username associated with the secret
+        password:
+          type: string
+          description: Secret value
+        url:
+          type: string
+          description: URL associated with the secret
+        description:
+          type: string
+          description: Human-readable description of this secret
     VaultOptions:
       title: Secret vault configuration
       description: Secret vault configuration. Set `type` to select the vault backend.
@@ -377,12 +493,14 @@ components:
         - $ref: "#/components/schemas/VaultHashicorpOptions"
         - $ref: "#/components/schemas/VaultSystemOptions"
         - $ref: "#/components/schemas/VaultFileOptions"
+        - $ref: "#/components/schemas/VaultOnePasswordOptions"
       discriminator:
         propertyName: type
         mapping:
-          vault:  "#/components/schemas/VaultHashicorpOptions"
-          system: "#/components/schemas/VaultSystemOptions"
-          file:   "#/components/schemas/VaultFileOptions"
+          vault:      "#/components/schemas/VaultHashicorpOptions"
+          system:     "#/components/schemas/VaultSystemOptions"
+          file:       "#/components/schemas/VaultFileOptions"
+          1password:  "#/components/schemas/VaultOnePasswordOptions"
     ImageOptions:
       type: object
       description: Options for displaying images and thumbnails in the terminal.
@@ -437,3 +555,155 @@ components:
             If `true`, creates a `<ID>.info.json` sidecar file inside the folder
             containing package metadata.
           default: false
+    NodeBearerTokenOptions:
+      type: object
+      description: >-
+        JWT payload used to generate an Aspera Node bearer token (`node bearer_token`).
+        `user_id` is the only mandatory field.
+        The CLI strips the `_validity` and `_scope` convenience keys before signing;
+        remaining fields are embedded verbatim in the token.
+      required:
+        - user_id
+      properties:
+        user_id:
+          type: string
+          description: Identifier of the user for whom the token is generated.
+          example: jdoe
+        _validity:
+          type: integer
+          description: Token lifetime in seconds (convenience key, removed before signing).
+          default: 86400
+        _scope:
+          type: string
+          description: >-
+            Scope shorthand used to build the `scope` field (convenience key, removed before signing).
+            Maps to `node.<access_key>:<scope>`.
+          enum: [user, admin]
+          default: user
+        scope:
+          type: string
+          description: >-
+            Full scope string. Computed automatically from `_scope` when absent.
+            Example: `node::ik-00000000-0000-0000-0000-000000000000:user`.
+        auth_type:
+          type: string
+          description: Authentication type embedded in the token.
+          default: access_key
+        expires_at:
+          type: string
+          description: >-
+            Token expiry timestamp in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).
+            Computed automatically from `_validity` when absent.
+          example: "2030-01-01T00:00:00Z"
+    NodeSimulatorOptions:
+      type: object
+      description: >-
+        Configuration for the embedded Node API simulator (`node simulator`).
+        The simulator starts a local WEBrick server that answers `/ops/transfers`,
+        `/ops/transfers/{id}`, `/files/browse`, and `/info` — sufficient to test
+        CLI commands against a live Node API without a real HSTS instance.
+      properties:
+        url:
+          type: string
+          description: >-
+            Address and port the simulator listens on.
+            Use `https://` with `cert`/`key` for TLS.
+          default: http://localhost:8080
+        cert:
+          type: string
+          description: >-
+            Path to the TLS certificate file.
+            Accepted formats: PEM (`.pem`) or PKCS12 (`.p12` / `.pfx`).
+          example: /path/to/cert.pem
+        key:
+          type: string
+          description: >-
+            Path to the PEM private key file, or the PKCS12 passphrase when `cert` is a `.p12`/`.pfx` file.
+          example: /path/to/key.pem
+        chain:
+          type: string
+          description: Path to the PEM certificate chain file (appended as extra chain certificates).
+          example: /path/to/chain.pem
+        browse_root:
+          type: string
+          description: >-
+            Root directory the simulator is allowed to expose via `/files/browse`.
+            Requests for paths outside this directory are rejected.
+            Defaults to the current working directory.
+          example: /data/aspera
+    NodeTelemetryOptions:
+      type: object
+      description: >-
+        Configuration for the telemetry reporter (`node telemetry`).
+        The command periodically queries `ops/transfers?active_only=true` and sends
+        an OpenTelemetry gauge metric to an Instana backend.
+      required:
+        - url
+        - key
+      properties:
+        url:
+          type: string
+          description: Base URL of the Instana backend (without `/v1`).
+          example: https://my-instana.example.com
+        key:
+          type: string
+          description: Instana API key sent in the `x-instana-key` header.
+          example: my-instana-api-key
+        interval:
+          type: number
+          format: float
+          description: >-
+            Polling interval in seconds. Use `0` for a single-shot run (no loop).
+          default: 10
+        hostname:
+          type: string
+          description: >-
+            Value sent in the `x-instana-host` header.
+            Defaults to the local machine's hostname.
+          example: hsts-prod-01
+    TableOptions:
+      type: object
+      description: Terminal table rendering options.
+      properties:
+        pivot:
+          type: string
+          description: Control how an object list is displayed (no/yes/single).
+          enum: ['no', 'yes', 'single']
+          default: 'no'
+    OutOptions:
+      type: object
+      description: Output rendering options (dot-notation sub-properties).
+      properties:
+        format:
+          type: string
+          description: Output format.
+          enum: [text, nagios, ruby, json, jsonpp, yaml, table, csv, image]
+          default: table
+        level:
+          type: string
+          description: Output verbosity level (which information to display).
+          enum: [info, data, error]
+          default: data
+        file:
+          type: string
+          description: Destination file for results (use `-` for stdout).
+        fields:
+          description: >-
+            Comma-separated list of fields to display, or a special value:
+            `ALL` for all fields, `DEF` for default fields.
+            Prefix a field name with `-` to exclude it.
+        select:
+          type: object
+          description: Select only matching items from a list (field/value filter or lambda).
+        table:
+          $ref: "#/components/schemas/TableOptions"
+        flat:
+          type: boolean
+          description: Display deep hash values as additional top-level keys.
+          default: true
+        secrets:
+          type: boolean
+          description: Show secrets in command output.
+          default: false
+        img:
+          $ref: "#/components/schemas/ImageOptions"