reqcord 0.1.4 → 0.3.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +42 -0
- data/README.md +115 -713
- data/docs/architecture.md +134 -0
- data/docs/capture.md +169 -0
- data/docs/configuration.md +32 -3
- data/docs/exporters.md +182 -0
- data/docs/getting-started.md +186 -0
- data/docs/route-coverage.md +91 -0
- data/docs/troubleshooting.md +113 -0
- data/docs/web.md +66 -0
- data/examples/reqcord.yml +3 -1
- data/lib/reqcord/capture/integration_patch.rb +9 -2
- data/lib/reqcord/check.rb +73 -0
- data/lib/reqcord/configuration.rb +10 -1
- data/lib/reqcord/dataset.rb +0 -1
- data/lib/reqcord/exporters/markdown.rb +5 -2
- data/lib/reqcord/exporters/openapi.rb +295 -0
- data/lib/reqcord/exporters/postman.rb +11 -1
- data/lib/reqcord/file_value.rb +62 -0
- data/lib/reqcord/generator.rb +17 -3
- data/lib/reqcord/renderers/curl.rb +22 -1
- data/lib/reqcord/renderers/payload.rb +25 -7
- data/lib/reqcord/route_collector.rb +10 -1
- data/lib/reqcord/schema.rb +11 -1
- data/lib/reqcord/version.rb +1 -1
- data/lib/reqcord/web.rb +122 -0
- data/lib/reqcord.rb +4 -0
- data/lib/tasks/reqcord.rake +26 -1
- data/reqcord.gemspec +2 -1
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b3ae152eca3f96656a35a94f78644254082c66a96838e948d4f8e38a27a876fa
|
|
4
|
+
data.tar.gz: b761ce17b9b67d2df73ec54416413a721798a2b74e041482f52227964cdc26c4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1b2e655adb41847e1509c7888f2329c323a6dcbcdf1a4273fc92bb80c22a4f2f3450e9f86a0aae1bec65f69c4c78f61dfe8f959db5af08def61ee4516d01825d
|
|
7
|
+
data.tar.gz: 6eb8f73ac77c942a82be407d32579b311ce62d007842381fbf447f1d4e884980845ecddccbc509c595dad5ba07fc14644d24aa3423d49634ef3868f6ba313bd3
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,47 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.3.0] - Unreleased
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
|
|
7
|
+
* Multipart uploads are documented. A `Rack::Test::UploadedFile` in a test's
|
|
8
|
+
params becomes a `file` field (shown by name, `label.png`), `--form
|
|
9
|
+
image=@label.png;type=image/png` in cURL, a `formdata` file part in Postman
|
|
10
|
+
and `type: string, format: binary` under `multipart/form-data` in OpenAPI.
|
|
11
|
+
The bytes never reach the dataset.
|
|
12
|
+
* `bin/rails reqcord:check` (`Reqcord::Check`): regenerates into a scratch
|
|
13
|
+
directory and compares with the committed output, file by file; exits 1
|
|
14
|
+
with a git-status style list when the docs are behind the tests — the CI
|
|
15
|
+
guard for documentation drift.
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
|
|
19
|
+
* Output is deterministic. Captured exchanges are ordered by test file, line
|
|
20
|
+
and name before the dataset is built, so "the first example" no longer
|
|
21
|
+
depends on the test run order, and `dataset.json` no longer carries a
|
|
22
|
+
`generated_at` timestamp. Regenerating without a code change produces no
|
|
23
|
+
diff.
|
|
24
|
+
|
|
25
|
+
### Fixed
|
|
26
|
+
|
|
27
|
+
* `routes.prefix` matches whole path segments: `/api` no longer swallows
|
|
28
|
+
`/api-docs` (which made a mounted `Reqcord::Web` show up as a skipped
|
|
29
|
+
route).
|
|
30
|
+
|
|
31
|
+
## [0.2.0] - 2026-09-16
|
|
32
|
+
|
|
33
|
+
### Added
|
|
34
|
+
|
|
35
|
+
* OpenAPI 3.1 exporter (`openapi/openapi.json`, on by default): one path item
|
|
36
|
+
per documented route (`/items(/:id)` becomes `/items` and `/items/{id}`),
|
|
37
|
+
parameters and request bodies from the inferred schemas, one response per
|
|
38
|
+
captured status with its example, bearer / API-key security schemes from
|
|
39
|
+
the sanitized headers.
|
|
40
|
+
* `Reqcord::Web`: `mount Reqcord::Web => "/api-docs"` serves the OpenAPI
|
|
41
|
+
document with Scalar and every other generated file (`dataset.json`, the
|
|
42
|
+
Postman collection, Markdown pages, cURL scripts) from inside the
|
|
43
|
+
application, Sidekiq::Web style.
|
|
44
|
+
|
|
3
45
|
## [0.1.4] - 2026-09-16
|
|
4
46
|
|
|
5
47
|
### Changed
|