ably-common/json-schemas/src/agents.json at main · ably/ably-common · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Ably Agents Definition",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string",
      "description": "The JSON Schema reference"
    },
    "agents": {
      "type": "array",
      "description": "An array containing all Ably agent identifiers and their properties.",
      "items": {
        "type": "object",
        "properties": {
          "identifier": {
            "description": "The identifier (product name) as it appears in the Ably-Agent string. See https://sdk.ably.com/builds/ably/specification/main/features/#RSC7d in the Ably Features spec for more information.",
            "type": "string"
          },
          "versioned": {
            "type": "boolean",
            "description": "If true, indicates that the identifier will have an associated version."
          },
          "type": {
            "type": "string",
            "description": "The software layer where the identifier is located.",
            "enum": ["os", "sdk", "wrapper", "runtime"]
          },
          "source": {
            "type": "string",
            "description": "The source code repository URL (required for SDK and wrapper types) where version and release information can be found.",
            "format": "uri"
          },
          "product": {
            "type": "string",
            "description": "The product category (required for SDK and wrapper types)",
            "enum": [
              "pub-sub",
              "asset-tracking",
              "platform",
              "livesync",
              "chat"
            ]
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the agent"
          },
          "versions": {
            "type": "array",
            "description": "Version information for SDKs and wrappers (only allowed for SDK and wrapper types)",
            "items": {
              "type": "object",
              "properties": {
                "sunsetted": {
                  "type": "array",
                  "description": "List of versions that are explicitly sunsetted (will no longer work after the sunsetDate)",
                  "items": {
                    "type": "object",
                    "properties": {
                      "upToVersion": {
                        "type": "string",
                        "description": "All versions up to and including this version are sunsetted"
                      },
                      "sunsetDate": {
                        "type": "string",
                        "description": "The date when these versions will stop working",
                        "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
                      },
                      "reason": {
                        "type": "string",
                        "description": "The reason why this version is being sunsetted"
                      }
                    },
                    "required": ["upToVersion", "sunsetDate", "reason"]
                  }
                }
              }
            }
          }
        },
        "required": ["identifier", "versioned", "type", "name"],
        "allOf": [
          {
            "if": {
              "properties": {
                "type": {
                  "enum": ["sdk", "wrapper"]
                }
              }
            },
            "then": {
              "required": ["source", "product"]
            }
          },
          {
            "if": {
              "properties": {
                "type": {
                  "enum": ["os", "runtime"]
                }
              }
            },
            "then": {
              "properties": {
                "versions": false,
                "source": false,
                "product": false
              }
            }
          }
        ]
      }
    },
    "ablyLibMappings": {
      "type": "object",
      "description": "An explicit mapping from x-ably-lib library and variant identifiers to ably-agent strings",
      "patternProperties": {
        "/.*/": {
          "description": "A format string which defines how the associated x-ably-lib prefix should be translated to an ably-agent string, for example 'ably-js/${version}'",
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false,
  "required": ["agents", "ablyLibMappings"]
}