Repository navigation
docs: document the configuration properties outside ovsx.scanning - #2195
Merged
Merged
Conversation
43 of the 83 properties the check tolerates as undocumented, leaving the 40 ovsx.scanning.* ones for a change of their own: they are a feature in their own right and are better reviewed by someone who knows it. Each entry gives the type, the default and the release that introduced it, in the reference's existing shape. The defaults come from config-properties-report.sh rather than being read off by hand, and the release from the first tag containing the commit that introduced the binding. Twenty of them are not in any release yet and say Unreleased, which wants replacing with the number when they ship. Three sections are new. Rate Limiting and Trusted Publishing are features with no section at all, and CORS is one property that belongs to neither the web UI nor the API sections it sits between. The baseline shrinks from 83 undocumented lines to 40, which is the point of it being a ratchet. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Follows #2194.
Documents 43 of the 83 properties the check tolerates as undocumented, leaving the 40
ovsx.scanning.*ones for a change of their own: they are a feature in their own right and betterreviewed by someone who knows it.
ovsx.caching.*ovsx.migrations.*ovsx.rate-limit.*ovsx.data.mirror.*ovsx.trusted-publishing.*ovsx.publishing.*ovsx.access-token.*How the facts were gathered
Not read off by hand:
config-properties-report.sh, the same scanner the check uses.git log -Sover the file that binds it - the key itself for a@Value, the camelCase field namefor a
@ConfigurationPropertiesfield. All 43 resolved; I spot-checked several against thehistory.
AGENTS.mdalreadyrequires to document each property.
Twenty are in no release yet and say
Unreleased. That is honest onmainand self-correctingin review, but wants replacing with the number when they ship - the largest groups are
ovsx.trusted-publishing.*and theovsx.access-token.token-hash-*family.Three new sections
Rate Limiting and Trusted Publishing are whole features with no section at all. CORS is
one property that belongs to neither the Web UI nor the Caching section it sits between.
The ratchet works
The baseline goes from 83 undocumented lines to 40, and the check refused to let me leave a stale
line behind - documenting the first 18 made it fail with "listed as undocumented in the baseline
but are now documented" until I deleted them.
All 174 property blocks in the reference were checked to have a well-formed
TypeandCompatibilityrow.A correction to #2191
Its description claimed that "nothing under
ovsx.publishing.is bound any more(
require-license,unsupported-icon-formats)". That was wrong:PublishingConfigbinds them via@ConfigurationProperties("ovsx.publishing"), which the crude${...}grep behind that figure couldnot see. The scanner always saw them correctly, so neither the check nor the baseline was ever
affected - only that sentence in a merged description.
Prepared with Claude Code.