Release API Tools 0.1.0

2026-09-01 12:39:23 +02:00
commit fbcd0e56d6
63 changed files with 10155 additions and 0 deletions
@@ -0,0 +1,41 @@
+# API Tools
+
+API Tools is a local-first OpenAPI workbench. Version 0.1.0 parses bounded JSON
+or YAML OpenAPI 3.0/3.1 descriptions, navigates operations, resolves `$ref`
+values from explicitly supplied local files, inventories security schemes,
+generates schema/request/response examples and inert client command text,
+compares revisions, and summarizes saved HTTP exchanges or HAR 1.2 files.
+
+It never executes HTTP, follows a URL, resolves a remote reference, stores a
+credential or loads an external asset. Generated curl, Fetch and Python snippets
+are text for review and may reproduce untrusted description values safely
+quoted for their target syntax.
+
+## Development and release
+
+Requires Node.js 22+ and npm 11+.
+
+```sh
+npm ci
+npm run check
+npm run test:browser
+npm run release:artifact
+```
+
+The release command writes deterministic `release/api-tools-0.1.0.zip` and a
+SHA-256 sidecar. Relative assets are tested at `/deep/nested/api/`.
+
+## v0.1 boundary
+
+- JSON/YAML files up to 4 MiB each, 20 files/16 MiB per selected workspace,
+  depth 64, 100,000 values, 50 YAML aliases, 2,000 operations;
+- focused OpenAPI identity/info/paths checks and remote-reference rejection;
+- fragment/relative-file JSON Pointer resolution with missing/cycle reports;
+- bounded sample generation for common schema composition and scalar formats;
+- path/query/request/response examples and inert curl/Fetch/Python output;
+- security scheme inventory, conservative operation compatibility report;
+- HAR or raw saved-exchange summary without rendering bodies or secrets.
+
+This is not a complete OpenAPI/JSON Schema validator, code generator, API
+client, proxy or security scanner. See the documented limitations and review
+generated values before use. Licensed under GPL-3.0-or-later.