|
| 1 | +# DEMO for DataFrame, this might differ from the actual API (it's updated a bit) |
| 2 | +openapi: 3.0.0 |
| 3 | +info: |
| 4 | + version: 2.0.2 |
| 5 | + title: APIs.guru |
| 6 | + description: > |
| 7 | + Wikipedia for Web APIs. Repository of API specs in OpenAPI format. |
| 8 | +
|
| 9 | +
|
| 10 | + **Warning**: If you want to be notified about changes in advance please join our [Slack channel](https://join.slack.com/t/mermade/shared_invite/zt-g78g7xir-MLE_CTCcXCdfJfG3CJe9qA). |
| 11 | +
|
| 12 | +
|
| 13 | + Client sample: [[Demo]](https://apis.guru/simple-ui) [[Repo]](https://github.com/APIs-guru/simple-ui) |
| 14 | + contact: |
| 15 | + name: APIs.guru |
| 16 | + url: https://APIs.guru |
| 17 | + |
| 18 | + license: |
| 19 | + name: CC0 1.0 |
| 20 | + url: https://github.com/APIs-guru/openapi-directory#licenses |
| 21 | + x-logo: |
| 22 | + url: https://apis.guru/branding/logo_vertical.svg |
| 23 | +externalDocs: |
| 24 | + url: https://github.com/APIs-guru/openapi-directory/blob/master/API.md |
| 25 | +security: [ ] |
| 26 | +tags: |
| 27 | + - name: APIs |
| 28 | + description: Actions relating to APIs in the collection |
| 29 | +paths: |
| 30 | + /list.json: |
| 31 | + get: |
| 32 | + operationId: listAPIs |
| 33 | + tags: |
| 34 | + - APIs |
| 35 | + summary: List all APIs |
| 36 | + description: > |
| 37 | + List all APIs in the directory. |
| 38 | +
|
| 39 | + Returns links to OpenAPI specification for each API in the directory. |
| 40 | +
|
| 41 | + If API exist in multiple versions `preferred` one is explicitly marked. |
| 42 | +
|
| 43 | +
|
| 44 | + Some basic info from OpenAPI spec is cached inside each object. |
| 45 | +
|
| 46 | + This allows to generate some simple views without need to fetch OpenAPI spec for each API. |
| 47 | + responses: |
| 48 | + "200": |
| 49 | + description: OK |
| 50 | + content: |
| 51 | + application/json; charset=utf-8: |
| 52 | + schema: |
| 53 | + $ref: "#/components/schemas/APIs" |
| 54 | + application/json: |
| 55 | + schema: |
| 56 | + $ref: "#/components/schemas/APIs" |
| 57 | + /metrics.json: |
| 58 | + get: |
| 59 | + operationId: getMetrics |
| 60 | + summary: Get basic metrics |
| 61 | + description: > |
| 62 | + Some basic metrics for the entire directory. |
| 63 | +
|
| 64 | + Just stunning numbers to put on a front page and are intended purely for WoW effect :) |
| 65 | + tags: |
| 66 | + - APIs |
| 67 | + responses: |
| 68 | + "200": |
| 69 | + description: OK |
| 70 | + content: |
| 71 | + application/json; charset=utf-8: |
| 72 | + schema: |
| 73 | + $ref: "#/components/schemas/Metrics" |
| 74 | + application/json: |
| 75 | + schema: |
| 76 | + $ref: "#/components/schemas/Metrics" |
| 77 | +components: |
| 78 | + schemas: |
| 79 | + APIs: |
| 80 | + description: | |
| 81 | + List of API details. |
| 82 | + It is a JSON object with API IDs(`<provider>[:<service>]`) as keys. |
| 83 | + type: object |
| 84 | + additionalProperties: |
| 85 | + $ref: "#/components/schemas/API" |
| 86 | + minProperties: 1 |
| 87 | + example: |
| 88 | + googleapis.com:drive: |
| 89 | + added: 2015-02-22T20:00:45.000Z |
| 90 | + preferred: v3 |
| 91 | + versions: |
| 92 | + v2: |
| 93 | + added: 2015-02-22T20:00:45.000Z |
| 94 | + info: |
| 95 | + title: Drive |
| 96 | + version: v2 |
| 97 | + x-apiClientRegistration: |
| 98 | + url: https://console.developers.google.com |
| 99 | + x-logo: |
| 100 | + url: https://api.apis.guru/v2/cache/logo/https_www.gstatic.com_images_icons_material_product_2x_drive_32dp.png |
| 101 | + x-origin: |
| 102 | + format: google |
| 103 | + url: https://www.googleapis.com/discovery/v1/apis/drive/v2/rest |
| 104 | + version: v1 |
| 105 | + x-preferred: false |
| 106 | + x-providerName: googleapis.com |
| 107 | + x-serviceName: drive |
| 108 | + swaggerUrl: https://api.apis.guru/v2/specs/googleapis.com/drive/v2/swagger.json |
| 109 | + swaggerYamlUrl: https://api.apis.guru/v2/specs/googleapis.com/drive/v2/swagger.yaml |
| 110 | + updated: 2016-06-17T00:21:44.000Z |
| 111 | + v3: |
| 112 | + added: 2015-12-12T00:25:13.000Z |
| 113 | + info: |
| 114 | + title: Drive |
| 115 | + version: v3 |
| 116 | + x-apiClientRegistration: |
| 117 | + url: https://console.developers.google.com |
| 118 | + x-logo: |
| 119 | + url: https://api.apis.guru/v2/cache/logo/https_www.gstatic.com_images_icons_material_product_2x_drive_32dp.png |
| 120 | + x-origin: |
| 121 | + format: google |
| 122 | + url: https://www.googleapis.com/discovery/v1/apis/drive/v3/rest |
| 123 | + version: v1 |
| 124 | + x-preferred: true |
| 125 | + x-providerName: googleapis.com |
| 126 | + x-serviceName: drive |
| 127 | + swaggerUrl: https://api.apis.guru/v2/specs/googleapis.com/drive/v3/swagger.json |
| 128 | + swaggerYamlUrl: https://api.apis.guru/v2/specs/googleapis.com/drive/v3/swagger.yaml |
| 129 | + updated: 2016-06-17T00:21:44.000Z |
| 130 | + API: |
| 131 | + description: Meta information about API |
| 132 | + type: object |
| 133 | + required: |
| 134 | + - added |
| 135 | + - preferred |
| 136 | + - versions |
| 137 | + properties: |
| 138 | + added: |
| 139 | + description: Timestamp when the API was first added to the directory |
| 140 | + type: string |
| 141 | + format: date-time |
| 142 | + preferred: |
| 143 | + description: Recommended version |
| 144 | + type: string |
| 145 | + versions: |
| 146 | + description: List of supported versions of the API |
| 147 | + type: object |
| 148 | + additionalProperties: |
| 149 | + $ref: "#/components/schemas/ApiVersion" |
| 150 | + minProperties: 1 |
| 151 | + additionalProperties: false |
| 152 | + ApiVersion: |
| 153 | + type: object |
| 154 | + required: |
| 155 | + - added |
| 156 | + # - updated apparently not required! |
| 157 | + - swaggerUrl |
| 158 | + - swaggerYamlUrl |
| 159 | + - info |
| 160 | + - openapiVer |
| 161 | + properties: |
| 162 | + added: |
| 163 | + description: Timestamp when the version was added |
| 164 | + type: string |
| 165 | + format: date-time |
| 166 | + updated: # apparently not required! |
| 167 | + description: Timestamp when the version was updated |
| 168 | + type: string |
| 169 | + format: date-time |
| 170 | + swaggerUrl: |
| 171 | + description: URL to OpenAPI definition in JSON format |
| 172 | + type: string |
| 173 | + format: url |
| 174 | + swaggerYamlUrl: |
| 175 | + description: URL to OpenAPI definition in YAML format |
| 176 | + type: string |
| 177 | + format: url |
| 178 | + info: |
| 179 | + description: Copy of `info` section from OpenAPI definition |
| 180 | + type: object |
| 181 | + minProperties: 1 |
| 182 | + externalDocs: |
| 183 | + description: Copy of `externalDocs` section from OpenAPI definition |
| 184 | + type: object |
| 185 | + minProperties: 1 |
| 186 | + openapiVer: |
| 187 | + description: OpenAPI version |
| 188 | + type: string |
| 189 | + additionalProperties: false |
| 190 | + |
| 191 | + Metrics: |
| 192 | + description: List of basic metrics |
| 193 | + type: object |
| 194 | + required: |
| 195 | + - numSpecs |
| 196 | + - numAPIs |
| 197 | + - numEndpoints |
| 198 | + - unreachable |
| 199 | + - invalid |
| 200 | + - unofficial |
| 201 | + - fixes |
| 202 | + - fixedPct |
| 203 | + - datasets |
| 204 | + - stars |
| 205 | + - issues |
| 206 | + - thisWeek |
| 207 | + properties: |
| 208 | + numSpecs: |
| 209 | + description: Number of API specifications including different versions of the |
| 210 | + same API |
| 211 | + type: integer |
| 212 | + minimum: 1 |
| 213 | + numAPIs: |
| 214 | + description: Number of APIs |
| 215 | + type: integer |
| 216 | + minimum: 1 |
| 217 | + numEndpoints: |
| 218 | + description: Total number of endpoints inside all specifications |
| 219 | + type: integer |
| 220 | + minimum: 1 |
| 221 | + unreachable: |
| 222 | + description: Number of unreachable specifications |
| 223 | + type: integer |
| 224 | + minimum: 0 |
| 225 | + invalid: |
| 226 | + description: Number of invalid specifications |
| 227 | + type: integer |
| 228 | + minimum: 0 |
| 229 | + unofficial: |
| 230 | + description: Number of unofficial specifications |
| 231 | + type: integer |
| 232 | + minimum: 0 |
| 233 | + fixes: |
| 234 | + description: Number of fixes applied to specifications |
| 235 | + type: integer |
| 236 | + minimum: 0 |
| 237 | + fixedPct: |
| 238 | + description: Percentage of fixed specifications |
| 239 | + type: number |
| 240 | + minimum: 0 |
| 241 | + maximum: 100 |
| 242 | + datasets: |
| 243 | + description: An overview of the datasets used to gather the APIs |
| 244 | + type: array |
| 245 | + items: |
| 246 | + description: A single metric per dataset |
| 247 | + type: object |
| 248 | + required: |
| 249 | + - title |
| 250 | + - data |
| 251 | + properties: |
| 252 | + title: |
| 253 | + description: Title of the metric |
| 254 | + type: string |
| 255 | + data: |
| 256 | + description: Value of the metric per dataset |
| 257 | + type: object |
| 258 | + additionalProperties: |
| 259 | + type: integer |
| 260 | + minimum: 0 |
| 261 | + stars: |
| 262 | + description: Number of stars on GitHub |
| 263 | + type: integer |
| 264 | + minimum: 0 |
| 265 | + issues: |
| 266 | + description: Number of issues on GitHub |
| 267 | + type: integer |
| 268 | + minimum: 0 |
| 269 | + thisWeek: |
| 270 | + description: Number of new specifications added/updated this week |
| 271 | + type: object |
| 272 | + required: |
| 273 | + - added |
| 274 | + - updated |
| 275 | + properties: |
| 276 | + added: |
| 277 | + description: Number of new specifications added this week |
| 278 | + type: integer |
| 279 | + minimum: 0 |
| 280 | + updated: |
| 281 | + description: Number of specifications updated this week |
| 282 | + type: integer |
| 283 | + minimum: 0 |
| 284 | + additionalProperties: false |
| 285 | + example: |
| 286 | + numSpecs: 1000 |
| 287 | + numAPIs: 100 |
| 288 | + numEndpoints: 10000 |
| 289 | + unreachable: 10 |
| 290 | + invalid: 10 |
| 291 | + unofficial: 10 |
| 292 | + fixes: 10 |
| 293 | + fixedPct: 10 |
| 294 | + datasets: |
| 295 | + - title: providerCount |
| 296 | + data: |
| 297 | + "a.com": 10 |
| 298 | + "b.com": 20 |
| 299 | + "c.com": 30 |
| 300 | + stars: 1000 |
| 301 | + issues: 100 |
| 302 | + thisWeek: |
| 303 | + added: 10 |
| 304 | + updated: 10 |
0 commit comments