Names-only secret dotenv example

Compose a deterministic literal .env.example and unresolved-variable checklist from explicit public and names-only secret declarations. Secret declarations accept no value/default field. Names-only secret declarations; public values supplied by the caller. No secret detection, secret-free certification, environment reads or changes.

structured · Operation ID: env-example-compose

Choose this operation when

Compile explicit declarations into a deterministic dotenv example with literal public defaults

Outside this profile

Secret scanning, secret-free certification, retrieving credentials or classifying whether caller public values contain secrets
Shell sourcing, escape syntax, variable interpolation, production configuration or environment mutation
Executing code, writing files, environment changes, network requests, publishing or deployment

Exact release references

Static JSON contract · Markdown reference · Fixed example response

Complete input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "variables": {
      "minItems": 1,
      "maxItems": 128,
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "pattern": "^[A-Z_][A-Z0-9_]{0,63}$"
              },
              "kind": {
                "type": "string",
                "const": "public"
              },
              "required": {
                "type": "boolean"
              },
              "description": {
                "type": "string",
                "maxLength": 256
              },
              "default": {
                "type": "string",
                "maxLength": 2048
              }
            },
            "required": [
              "name",
              "kind",
              "required"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "pattern": "^[A-Z_][A-Z0-9_]{0,63}$"
              },
              "kind": {
                "type": "string",
                "const": "secret"
              },
              "required": {
                "type": "boolean"
              },
              "description": {
                "type": "string",
                "maxLength": 256
              }
            },
            "required": [
              "name",
              "kind",
              "required"
            ],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "required": [
    "variables"
  ],
  "additionalProperties": false
}

Complete output-envelope schema

{
  "type": "object",
  "required": [
    "operation",
    "version",
    "result",
    "provenance"
  ],
  "properties": {
    "operation": {
      "const": "env-example-compose",
      "type": "string"
    },
    "version": {
      "const": "0.29.0",
      "type": "string"
    },
    "result": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "profile": {
          "type": "string",
          "const": "dotenv-literal-example-v1"
        },
        "text": {
          "type": "string"
        },
        "byteLength": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "declaredSecretNames": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[A-Z_][A-Z0-9_]{0,63}$"
          }
        },
        "requiredWithoutDefaults": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[A-Z_][A-Z0-9_]{0,63}$"
          }
        },
        "optionalWithoutDefaults": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[A-Z_][A-Z0-9_]{0,63}$"
          }
        },
        "manifest": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "pattern": "^[A-Z_][A-Z0-9_]{0,63}$"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "public",
                  "secret"
                ]
              },
              "required": {
                "type": "boolean"
              },
              "hasDefault": {
                "type": "boolean"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "name",
              "kind",
              "required",
              "hasDefault",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "classification": {
          "type": "string",
          "const": "Names-only secret declarations; public values supplied by the caller."
        },
        "externalRequests": {
          "type": "number",
          "const": 0
        },
        "environmentChanged": {
          "type": "boolean",
          "const": false
        }
      },
      "required": [
        "profile",
        "text",
        "byteLength",
        "declaredSecretNames",
        "requiredWithoutDefaults",
        "optionalWithoutDefaults",
        "manifest",
        "classification",
        "externalRequests",
        "environmentChanged"
      ],
      "additionalProperties": false
    },
    "provenance": {
      "type": "object",
      "required": [
        "inputSha256",
        "outputSha256",
        "deterministic",
        "externalRequests"
      ],
      "properties": {
        "inputSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "outputSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "deterministic": {
          "const": true
        },
        "externalRequests": {
          "const": 0
        }
      }
    }
  },
  "additionalProperties": false
}

Fixed example

One accepted fixed example, not a custom-input trial. No operation runs when this static page is requested.

Example input

{
  "variables": [
    {
      "name": "API_BASE",
      "kind": "public",
      "required": true,
      "default": "https://example.invalid/v1"
    },
    {
      "name": "API_KEY",
      "kind": "secret",
      "required": true
    },
    {
      "name": "DEBUG",
      "kind": "public",
      "required": false,
      "default": "false"
    }
  ]
}

Example response

{
  "operation": "env-example-compose",
  "version": "0.29.0",
  "result": {
    "profile": "dotenv-literal-example-v1",
    "text": "API_BASE='https://example.invalid/v1'\n# Required secret: API_KEY\nDEBUG='false'\n",
    "byteLength": 79,
    "declaredSecretNames": [
      "API_KEY"
    ],
    "requiredWithoutDefaults": [
      "API_KEY"
    ],
    "optionalWithoutDefaults": [],
    "manifest": [
      {
        "name": "API_BASE",
        "kind": "public",
        "required": true,
        "hasDefault": true,
        "description": null
      },
      {
        "name": "API_KEY",
        "kind": "secret",
        "required": true,
        "hasDefault": false,
        "description": null
      },
      {
        "name": "DEBUG",
        "kind": "public",
        "required": false,
        "hasDefault": true,
        "description": null
      }
    ],
    "classification": "Names-only secret declarations; public values supplied by the caller.",
    "externalRequests": 0,
    "environmentChanged": false
  },
  "provenance": {
    "inputSha256": "53598ba3cbc88dca06116cd5d2e1aee89d6e21bfee339ed11bb4bf77ea3b654f",
    "outputSha256": "58044952de5e7a5301a62a40a7f0804e8c887d429e45436c16002485fa32d136",
    "deterministic": true,
    "externalRequests": 0
  }
}

Bounds and precision

JavaScript IEEE-754 numbers; use strings for large integer IDs/exact decimals where the schema accepts strings. No lossless numeric parsing.

{
  "global": {
    "requestBytes": 131072,
    "responseBytes": 524288,
    "jsonDepth": 32,
    "jsonNodes": 20000,
    "requestsPerMinute": 60,
    "paidAttemptsPerMinute": 20,
    "idempotencyHours": 24
  },
  "operation": {
    "inputBytes": 100000,
    "outputBytes": 400000,
    "jsonNodes": 12000,
    "depth": 20,
    "variables": 128,
    "nameUnits": 64,
    "descriptionUnits": 256,
    "defaultBytes": 2048,
    "textBytes": 100000
  }
}

Complete schemas, descriptions and cross-field validation may impose additional limits.

Proposed price and protocol definitions

{
  "unit": "one successful operation call",
  "proposedNominalUsd": "0.003",
  "sixDecimalTokenBaseUnits": "3000",
  "subscription": false,
  "includesPayerWalletOrNetworkFees": false,
  "liveQuoteVerified": false,
  "condition": "Actual SDK challenge is authoritative only within the caller's explicit authorization; configured six-decimal token peg is an operator assertion, not a conversion guarantee."
}

Protocol definitions: x402, mpp. MPP uses Tempo charge. Paid MCP execution is unsupported. All runtime readiness is not evaluated in this build.

API path templates, not endpoints on this documentation host

{
  "x402": "/v1/x402/env-example-compose",
  "mpp": "/v1/mpp/env-example-compose"
}

Required headers

{
  "Content-Type": "application/json",
  "Idempotency-Key": "random 16–128 character operation identifier"
}

Actual SDK challenge amount, asset, network, recipient and wallet costs must pass independent authorization. Preserve identical key, body, protocol and credential on retries; on PAYMENT_UNCERTAIN stop and reconcile.

Execution profile and provider conditions

{
  "deterministic": true,
  "externalRequests": 0,
  "maxExternalRequests": 0,
  "resultSnapshotPersisted": false,
  "fixedExampleIsIllustrativeSnapshot": false,
  "requiresPayment": true,
  "supportsMcpExecution": false
}

Deterministic supplied-input operation with no external requests or stored request/result bodies. Payment infrastructure retains payment metadata and hashes.

Failure handling

HTTP 400: Malformed JSON, missing/invalid idempotency key, or payment identifier mismatch Correct the request before payment
HTTP 402: Payment challenge or rejected payment Use official protocol SDK; inspect payment outcome before another payment
HTTP 409: Idempotency conflict, duplicate proof, or PAYMENT_UNCERTAIN Keep original key, body, and proof; reconcile uncertainty with operator; never blindly repay
HTTP 413: Input or generated output too large Reduce input; no payment attempted for validation failure
HTTP 415: Unsupported media type or compression Send uncompressed application/json
HTTP 422: Schema or service-specific semantic validation failure Correct input using returned error code; no payment attempted
HTTP 429: Request/payment-attempt rate exceeded Wait for rate limit window; preserve existing payment identity
HTTP 503: Payment configuration/provider/state unavailable, or live DNS preparation failed before settlement Check readiness; DNS preparation failures may retry the identical key/body/credential only; uncertainty requires reconciliation

Declared requirements

Before any paid call, refresh the live operation contract and POST the complete bounded budgeted plan to the separate API's /preflight. Unknown requirements block selection; compatible preflight is not permission to spend.