analysis/json-schema/analysis-api-tool-schema.json at main · api-evangelist/analysis · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/analysis/refs/heads/main/json-schema/analysis-api-tool-schema.json",
  "title": "APIAnalysisTool",
  "description": "Schema representing an API analysis, analytics, or monitoring tool",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Tool name",
      "example": "Spectral"
    },
    "description": {
      "type": "string",
      "description": "Tool description"
    },
    "category": {
      "type": "string",
      "enum": [
        "linting",
        "traffic_analysis",
        "security",
        "analytics",
        "monitoring",
        "apm",
        "governance"
      ],
      "description": "Tool category"
    },
    "license": {
      "type": "string",
      "enum": [
        "open_source",
        "commercial",
        "freemium"
      ],
      "description": "License model"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Tool website URL"
    },
    "github": {
      "type": "string",
      "format": "uri",
      "description": "GitHub repository URL"
    },
    "api": {
      "type": "boolean",
      "description": "Whether the tool exposes an API"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Classification tags"
    }
  }
}