Ampersand · JSON Structure

Ampersand Api Config Structure

Config schema from Ampersand API

Type: object Properties: 5 Required: 5
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Config is a JSON Structure definition published by Ampersand, describing 5 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id revisionId createTime createdBy content

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-config-structure.json",
  "name": "Config",
  "description": "Config schema from Ampersand API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The config ID.",
      "example": "config-123"
    },
    "revisionId": {
      "type": "string",
      "description": "The ID of the revision that was current when this config was created or last updated. \n",
      "example": "revision-123"
    },
    "createTime": {
      "type": "datetime",
      "description": "The time the config was created."
    },
    "createdBy": {
      "type": "string",
      "description": "The person who created the config, in the format of \"consumer:{consumer-id}\" or \"builder:{builder-id}\".",
      "example": "builder:builder-123"
    },
    "content": {
      "$ref": "../config/config.yaml#/components/schemas/ConfigContent"
    }
  },
  "required": [
    "content",
    "createTime",
    "createdBy",
    "id",
    "revisionId"
  ]
}