OpenCollection YAML Format — CAPost Documentation

The OpenCollection YAML Standard

Unlike closed binary formats used by competitors, CAPost stores your entire workspace into human-readable, standard YAML files. These YAML files can be safely versioned in Git and executed directly by CI/CD pipelines.

Standard Collection Schema

openCollection: "1.2"
metadata:
  name: "E-commerce REST API"
  author: "cecep-azhar"
  
environments:
  - name: "Staging"
    variables:
      - key: "BASE_URL"
        value: "https://staging-api.example.com"

items:
  - name: "Order Management"
    type: "folder"
    items:
      - name: "Create Order"
        request:
          method: "POST"
          url: "{{BASE_URL}}/v1/orders"
          headers:
            - name: "Authorization"
              value: "Bearer {{API_TOKEN}}"
            - name: "Content-Type"
              value: "application/json"
          body:
            type: "json"
            raw: |
              {
                "item_id": "{{product_sku}}",
                "quantity": 2
              }
          tests:
            - description: "Verify successful order creation"
              expression: "postman.getResponseCode() === 201"
            - description: "Validate order payload shape"
              type: "json-schema"
              schema: |
                {
                  "type": "object",
                  "properties": {
                    "data": { "type": "string" }
                  }
                }

Version Control Best Practices

Separate Secrets: Store opencollection.yaml in your Git repository, but keep actual sensitive values (API keys, DB passwords) in the Zero-Knowledge Vault and reference them via variables.
Git Subdirectories: Organize large collections into subfolders with dedicated collection.yaml files.