docs: document dry-run, output contracts and import-url reference - #509
Open
Caesarsage wants to merge 4 commits into
Open
Caesarsage wants to merge 4 commits into
Caesarsage wants to merge 4 commits into
Conversation
Signed-off-by: caesarsage <destinyerhabor6@gmail.com>
Signed-off-by: caesarsage <destinyerhabor6@gmail.com>
Signed-off-by: caesarsage <destinyerhabor6@gmail.com>
Signed-off-by: caesarsage <destinyerhabor6@gmail.com>
Contributor
Author
|
for review |
Vaishnav88sk
suggested changes
Sep 17, 2026
Vaishnav88sk
left a comment
Vaishnav88sk
left a comment
Contributor
There was a problem hiding this comment.
These are non blocking. Just for format. 😉
Comment on lines
+42
to
+43
| `test` is the only command that renders a full `TestResult`, so it is the only one | ||
| offering `yaml` and `github-actions`. Everything else exposes `text` or `json`. |
Contributor
There was a problem hiding this comment.
There is a minor contradiction here. The text states that test is the only command that renders a full TestResult, but the table in the very next section correctly points out that test get also renders a complete TestResult object when using --output json.
Suggestion: Reword this to clarify
Comment on lines
73
to
+74
| | `import-dir` | Scan a directory and import API spec files. | [`import-dir`](documentation/cmd/importDir.md) | | ||
| | `import-url` | Import API spec files directly from a remote URL | [`import-url`](documentation/cmd/importUrl.md) | | ||
| | `import-url` | Import API spec files directly from a remote URL | [`import-url`](documentation/cmd/importURL.md) | |
Contributor
There was a problem hiding this comment.
Additional: Could you also fix the alignment of the import-dir row right above it? It currently has an extra space after the command name.
Contributor
|
@Harsh4902 Above chnages are non-blocking. Docs are good. It is good to merge. 👍🏻 |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only pass closing the gaps between what 1.0.3 ships and what the
reference docs describe.
documentation/cmd/test.md— adds the dry-run surface, which existed only as aREADME section. All six flags with defaults, plus behaviour previously visible only in
source: flags rejected without
--dry-run(exit2), the*-nativeimage requirement,Podman auto-detection,
localhostendpoint rewriting, and teardown on every exit path.documentation/json-output.md(new) — one reference for consuming the CLIprogrammatically: stream discipline, format matrix, payload shapes, and the dry-run
NDJSON event schema, which was documented nowhere despite being the contract editor
and CI integrations bind to.
documentation/cmd/importURL.md— documents the<specURL>[:<mainArtifact>[:<secretName>]]grammar and the right-to-left parsing thatkeeps URLs-with-ports working (fix (cmd) : URL Port Corrupts Input in Import-URL Command #465).
README.md— adds--driverand a Reference table, and fixes a link toimportUrl.mdthat 404s on GitHub (the file isimportURL.md; it only resolvedlocally on case-insensitive filesystems).