Ampersand · Schema

Config

Config schema from Ampersand API

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name	Type	Description
id	string	The config ID.
revisionId	string	The ID of the revision that was current when this config was created or last updated.
createTime	string	The time the config was created.
createdBy	string	The person who created the config, in the format of "consumer:{consumer-id}" or "builder:{builder-id}".
content	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-config-schema.json",
  "title": "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": "string",
      "description": "The time the config was created.",
      "format": "date-time"
    },
    "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"
  ]
}