docs: name the package unbound/srv and unbound/ext need, in the API reference - #188
Merged
Conversation
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
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.
unbound/srvandunbound/extwrite uci packages that only the separateunbound-uci-extpackage renders, and both declarereload: ["unbound-uci-ext"]. Without it installed, the first write returns503 init_script_missing.docs/resources.mdalready says so, in full, including the error code. The API reference did not: both tags existed with no description at all, so someone browsing 48 endpoints in Redoc had nothing to tell them these two need a second install.Both now carry one, naming the package and the exact failure, with wording matched to
docs/resources.mdand the code intransaction.ucrather than paraphrased.Worth recording that I first reported this as "uapi does not tell users they need it anywhere". That was wrong: my grep truncated the catalog row at 135 characters, and I read a missing phrase as a missing fact. The repo docs were correct all along; the gap was only in the generated reference.
Does this change the wire surface? The document only, and only tag descriptions. No paths, schemas, statuses or headers move.
Was it verified against a real device, or only by CI? Neither is needed for tag prose, but the claim it encodes was measured yesterday on a device: a write to
/unbound/extreaches uci, theunbound-uci-extinit script renders/etc/unbound/unbound_ext.conf, and the managed block appears with the line that was written.make lint,openapi-checkand 1234 unit tests pass.Was LuCI checked? Not applicable; the split between uapi and the renderer package is this project's own arrangement.