Universal-Dev-Registery-DB/postman.json at main · Ambastha-Org/Universal-Dev-Registery-DB · 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
{
  "info": {
    "name": "Compatibility Matrix API",
    "_postman_id": "c3b1f4c0-7b5e-4b2a-b5d7-2b07c1e37a5f",
    "description": "Full test collection for Compatibility Matrix API (GET, POST, PUT, DELETE) including version compression logic",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "GET All Active Entries",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "http://localhost:8080/api/v1/matrix",
          "protocol": "http",
          "host": ["localhost"],
          "port": "8080",
          "path": ["api", "v1", "matrix"]
        },
        "description": "Fetch all active entries, returns either `incompatible_versions` or `incompatible_ranges` if compressed."
      },
      "response": []
    },
    {
      "name": "POST Create Compatibility Entry",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "X-Admin-API-Key",
            "value": "<YOUR_ADMIN_KEY>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"package_name\": \"node-fetch\",\n  \"ecosystem\": \"npm\",\n  \"current_version\": \"3.3.0\",\n  \"latest_version\": \"3.4.1\",\n  \"compatibility_status\": \"INCOMPATIBLE\",\n  \"reason\": \"Breaking ESM-only changes cause failures in CommonJS projects.\",\n  \"recommended_action\": \"Upgrade to ESM or downgrade to v2.\",\n  \"incompatible_versions\": [\"2.6.0\", \"2.6.1\", \"2.6.2\", \"3.0.0\", \"3.0.1\", \"3.0.2\"]\n}"
        },
        "url": {
          "raw": "http://localhost:8080/api/v1/matrix",
          "protocol": "http",
          "host": ["localhost"],
          "port": "8080",
          "path": ["api", "v1", "matrix"]
        },
        "description": "Creates a new compatibility entry. Will automatically compress versions into `incompatible_ranges` if possible."
      },
      "response": []
    },
    {
      "name": "PUT Update Compatibility Entry",
      "request": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "X-Admin-API-Key",
            "value": "<YOUR_ADMIN_KEY>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"latest_version\": \"3.5.0\",\n  \"incompatible_versions\": [\"2.6.0\", \"2.6.1\", \"3.0.0\"]\n}"
        },
        "url": {
          "raw": "http://localhost:8080/api/v1/matrix/<ENTRY_ID>",
          "protocol": "http",
          "host": ["localhost"],
          "port": "8080",
          "path": ["api", "v1", "matrix", "<ENTRY_ID>"]
        },
        "description": "Updates an existing entry by ID. Compression will run if `incompatible_versions` can be turned into ranges."
      },
      "response": []
    },
    {
      "name": "DELETE Disable Compatibility Entry",
      "request": {
        "method": "DELETE",
        "header": [
          {
            "key": "X-Admin-API-Key",
            "value": "<YOUR_ADMIN_KEY>"
          }
        ],
        "url": {
          "raw": "http://localhost:8080/api/v1/matrix/<ENTRY_ID>",
          "protocol": "http",
          "host": ["localhost"],
          "port": "8080",
          "path": ["api", "v1", "matrix", "<ENTRY_ID>"]
        },
        "description": "Soft-deletes (disables) an entry by ID. Entry remains in DB but `is_active` is set to false."
      },
      "response": []
    },
    {
      "name": "GET Health Endpoint",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "http://localhost:8080/health",
          "protocol": "http",
          "host": ["localhost"],
          "port": "8080",
          "path": ["health"]
        },
        "description": "Health check endpoint. Also triggers background compression for month-old entries without blocking the response."
      },
      "response": []
    }
  ]
}