aggregation/json-structure/aggregation-unified-api-structure.json at main · api-evangelist/aggregation · 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
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aggregation/refs/heads/main/json-structure/aggregation-unified-api-structure.json",
  "name": "UnifiedAPI",
  "description": "Represents a unified API aggregation layer that exposes multiple underlying provider APIs through a single normalized interface.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the unified API platform.",
      "example": "Merge HR API"
    },
    "description": {
      "type": "string",
      "description": "Description of what the unified API covers.",
      "example": "Unified API for syncing employee data across BambooHR, Workday, ADP, and 50+ other HR systems."
    },
    "category": {
      "type": "string",
      "description": "Business category covered by the unified API.",
      "enum": [
        "HR",
        "CRM",
        "Accounting",
        "ATS",
        "File Storage",
        "E-Commerce",
        "Financial",
        "Other"
      ],
      "example": "HR"
    },
    "providers": {
      "type": "array",
      "description": "List of underlying API providers aggregated by this unified API.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "BambooHR"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "beta",
              "deprecated"
            ],
            "example": "active"
          }
        }
      }
    },
    "base_url": {
      "type": "uri",
      "description": "Base URL of the unified API.",
      "example": "https://api.merge.dev/api/hris/v1"
    },
    "authentication": {
      "type": "object",
      "description": "Authentication mechanism for the unified API.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "bearer",
            "apikey",
            "oauth2"
          ],
          "example": "bearer"
        }
      }
    },
    "normalized_schema": {
      "type": "boolean",
      "description": "Whether the API normalizes response schemas across all underlying providers.",
      "example": true
    }
  },
  "required": [
    "name",
    "category"
  ]
}