Skip to content

docs(resolver): stop claiming GS1 conformance - #478

Open
LKSNDRTMLKV wants to merge 1 commit into
mainfrom
fix/resolver-gs1-conformance-claim
Open

LKSNDRTMLKV wants to merge 1 commit into
mainfrom
fix/resolver-gs1-conformance-claim

Conversation

@LKSNDRTMLKV

Copy link
Copy Markdown
Member

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.
  • CHANGELOG entry under Fixed.

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

  • Tests added or updated for new behaviour (wording only; nothing to test)
  • just lint passes locally
  • just fmt applied
  • just test passes (unit)
  • No println!/eprintln!/dbg! in service-crate src/
  • No secrets, credentials, or .env files in the diff
  • Docs updated if a public API, endpoint, or CLI command changed
  • just openapi-check passes (bundle matches the tree; lint clean)

Note on just check

Every step of just check passes except the last, audit. It fails the same way on main: the wasmtime advisories published on 14 October (fixed in 49.0.3 and later, one of them a sandbox escape in wasmtime-wasi) and the yanked zip 8.6.0. This change touches no dependency, so it neither causes nor can clear them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The resolver says it conforms to the GS1 Conformant Resolver Standard, and two of its required criteria are unmet

1 participant