Repository navigation
docs(resolver): stop claiming GS1 conformance - #478
Open
LKSNDRTMLKV wants to merge 1 commit into
Open
LKSNDRTMLKV wants to merge 1 commit into
LKSNDRTMLKV wants to merge 1 commit into
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.
Summary
The resolver's handler documentation and the description of
GET /01/{gtin}called it a "GS1-conformant resolver (GS1-CRSV1)". Nothing backs that: no revision is named, no test names the standard's criteria, and two required criteria are unmet (a description of the resolver served from/.well-known/gs1resolver, and decompression of a compressed Digital Link). This replaces the claim with wording that describes the behaviour and says it has not been assessed against the standard.Related issue
Closes #469. Earning the claim (mapping all 25 criteria, implementing the two missing ones, recording the evidence) stays with #477.
Changes
resolve_by_gtin.rs: the module and handler documentation no longer say the routes conform.api/paths/resolver/01_{gtin}.yaml: the route description says the same, and the bundled spec is regenerated.The module documentation still cites GS1-CRSV1 clauses where it explains how a granular identifier is answered. Those describe behaviour, not a claim, and are unchanged.
Checklist
just lintpasses locallyjust fmtappliedjust testpasses (unit)println!/eprintln!/dbg!in service-cratesrc/.envfiles in the diffjust openapi-checkpasses (bundle matches the tree; lint clean)Note on
just checkEvery step of
just checkpasses except the last,audit. It fails the same way onmain: the wasmtime advisories published on 14 October (fixed in 49.0.3 and later, one of them a sandbox escape inwasmtime-wasi) and the yankedzip 8.6.0. This change touches no dependency, so it neither causes nor can clear them.