Manifest

// GET /.well-known/surf.json
{
  "surf": "1.0",
  "name": "My Store",
  "description": "A Surf-enabled e-commerce API",
  "version": "1.0.0",
  "baseUrl": "https://shop.example.com",
  "auth": {
    "type": "bearer",
    "description": "JWT Bearer token"
  },
  "commands": {
    "search": {
      "description": "Search products",
      "params": {
        "query": { "type": "string", "required": true },
        "limit": { "type": "number", "default": 10 }
      },
      "returns": { "type": "object" },
      "tags": ["catalog"],
      "hints": { "idempotent": true, "sideEffects": false }
    },
    "cart.add": {
      "description": "Add item to cart",
      "params": { "sku": { "type": "string", "required": true } },
      "auth": "required"
    }
  },
  "events": {
    "cart.updated": {
      "description": "Cart contents changed",
      "data": { "items": { "type": "array" } }
    }
  },
  "types": {
    "CartItem": {
      "type": "object",
      "properties": { "sku": { "type": "string" }, "quantity": { "type": "number" } }
    }
  },
  "checksum": "a1b2c3d4e5f6...",
  "updatedAt": "2025-03-20T18:00:00.000Z"
}