@apifreaks/openapi-specs 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -7
- package/dist/index.cjs +2542 -2411
- package/dist/index.d.cts +2 -3
- package/dist/index.d.ts +2 -3
- package/dist/index.js +2542 -2411
- package/dist/specs/email-validation/bulk-email-validation.yaml +59 -12
- package/dist/specs/email-validation/email-checker.yaml +52 -10
- package/package.json +1 -1
- package/specs/email-validation/bulk-email-validation.json +90 -13
- package/specs/email-validation/email-checker.json +67 -11
- /package/dist/specs/{general → billing}/usage-credits.yaml +0 -0
- /package/dist/specs/{geodb → geography}/administrative-units-details.yaml +0 -0
- /package/dist/specs/{geodb → geography}/administrative-units-levels.yaml +0 -0
- /package/dist/specs/{geodb → geography}/administrative-units.yaml +0 -0
- /package/dist/specs/{geodb → geography}/cities.yaml +0 -0
- /package/dist/specs/{geodb → geography}/countries-details.yaml +0 -0
- /package/dist/specs/{geodb → geography}/countries.yaml +0 -0
- /package/dist/specs/{geodb → geography}/flags-supported.yaml +0 -0
- /package/dist/specs/{geodb → geography}/flags.yaml +0 -0
- /package/dist/specs/{geodb → geography}/regions.yaml +0 -0
- /package/dist/specs/{geodb → geography}/subregions.yaml +0 -0
- /package/dist/specs/{other → weather}/astronomy-data.yaml +0 -0
- /package/specs/{general → billing}/usage-credits.json +0 -0
- /package/specs/{geodb → geography}/administrative-units-details.json +0 -0
- /package/specs/{geodb → geography}/administrative-units-levels.json +0 -0
- /package/specs/{geodb → geography}/administrative-units.json +0 -0
- /package/specs/{geodb → geography}/cities.json +0 -0
- /package/specs/{geodb → geography}/countries-details.json +0 -0
- /package/specs/{geodb → geography}/countries.json +0 -0
- /package/specs/{geodb → geography}/flags-supported.json +0 -0
- /package/specs/{geodb → geography}/flags.json +0 -0
- /package/specs/{geodb → geography}/regions.json +0 -0
- /package/specs/{geodb → geography}/subregions.json +0 -0
- /package/specs/{other → weather}/astronomy-data.json +0 -0
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @apifreaks/openapi-specs
|
|
2
2
|
|
|
3
|
-
OpenAPI 3.1 specifications for all [APIFreaks](https://apifreaks.com) API products. Ships
|
|
3
|
+
OpenAPI 3.1 specifications for all [APIFreaks](https://apifreaks.com) API products. Ships 104 production specs across 20 categories as typed JSON, importable as ESM, CJS, or raw JSON.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -55,8 +55,8 @@ const { getSpec, SPEC_SLUGS } = require("@apifreaks/openapi-specs");
|
|
|
55
55
|
| ------------------------------ | -------------------------------------- | --------------------------------------------------- |
|
|
56
56
|
| `getSpec(slug)` | `(string) => OpenAPISpec \| undefined` | Returns the full spec object for a given slug |
|
|
57
57
|
| `getSpecsByCategory(category)` | `(string) => string[]` | Returns all slugs in a category, or `[]` if unknown |
|
|
58
|
-
| `SPEC_SLUGS` | `string[]` | All
|
|
59
|
-
| `SPEC_CATEGORIES` | `string[]` | All
|
|
58
|
+
| `SPEC_SLUGS` | `string[]` | All 104 spec slugs |
|
|
59
|
+
| `SPEC_CATEGORIES` | `string[]` | All 20 category names |
|
|
60
60
|
| `SPECS` | `Record<string, OpenAPISpec>` | Full spec objects keyed by slug |
|
|
61
61
|
| `SPECS_BY_CATEGORY` | `Record<string, string[]>` | Slugs grouped by category |
|
|
62
62
|
|
|
@@ -72,17 +72,16 @@ import type { OpenAPISpec } from "@apifreaks/openapi-specs";
|
|
|
72
72
|
|
|
73
73
|
| Category | Count | Description |
|
|
74
74
|
| ------------------ | ----- | ------------------------------------------------------- |
|
|
75
|
+
| `billing` | 1 | Usage and credits |
|
|
75
76
|
| `commodity` | 5 | Commodity prices, symbols, time series |
|
|
76
77
|
| `currency` | 10 | Exchange rates, conversion, historical data |
|
|
77
78
|
| `dns` | 4 | DNS lookup, reverse DNS, history |
|
|
78
79
|
| `domain` | 4 | Domain search, checker, subdomain lookup |
|
|
79
80
|
| `email-validation` | 2 | Email verification and bulk validation |
|
|
80
81
|
| `financial` | 8 | VAT rates, IBAN/SWIFT validation |
|
|
81
|
-
| `general` | 1 | Usage and credits |
|
|
82
82
|
| `geocoding` | 2 | Forward and reverse geocoding |
|
|
83
|
-
| `
|
|
83
|
+
| `geography` | 10 | Countries, cities, regions, flags, administrative units |
|
|
84
84
|
| `ip-intelligence` | 4 | IP geolocation, threat intelligence, bulk lookup |
|
|
85
|
-
| `other` | 1 | Astronomy data |
|
|
86
85
|
| `pdf` | 19 | PDF manipulation, conversion, encryption |
|
|
87
86
|
| `phone-validation` | 2 | Phone number validation |
|
|
88
87
|
| `scraper` | 1 | Web scraping |
|
|
@@ -90,7 +89,7 @@ import type { OpenAPISpec } from "@apifreaks/openapi-specs";
|
|
|
90
89
|
| `ssl` | 2 | SSL certificate lookup |
|
|
91
90
|
| `timezone` | 2 | Timezone lookup and conversion |
|
|
92
91
|
| `user-agent` | 2 | User-agent parsing |
|
|
93
|
-
| `weather` |
|
|
92
|
+
| `weather` | 9 | Current, forecast, historical, marine weather, astronomy |
|
|
94
93
|
| `whois` | 6 | WHOIS lookup, ASN, reverse WHOIS |
|
|
95
94
|
| `zip-code` | 7 | Zip code lookup, distance, radius search |
|
|
96
95
|
|