Schema complaiance incorrect field documentation #8

New issue

Closed

opened 2026-08-27 05:41:21 +00:00 by Xeplosion · 0 comments

Xeplosion commented

2026-08-27 05:41:21 +00:00

Owner

Where is the problem?

schema/provider-schema-v2.3.json (provider.reviews.complies_with_guidelines and
compliance_notes descriptions), tools/capture-form/index.html (Reviews step
label), docs/capture-guide.md, docs/bootstrap-guide.md

Type of problem

Incorrect — the docs say something wrong

What's wrong and what should it say?

complies_with_guidelines and its label/description were worded as generic
"scraping guidelines" compliance. The field is actually specifically about
compliance with Trustpilot's Terms of Service (this is the reviews section —
trustpilot_url, review_count, scrapes are all Trustpilot-scoped).

Corrected wording has already been applied locally (not yet committed):

schema description → "Whether the review scrape complied with Trustpilot's
Terms of Service. Null = not yet assessed."
compliance_notes description → references Trustpilot's ToS specifically,
robots.txt kept as a secondary note
capture-form UI label → "Complies with Trustpilot's Terms of Service?"
docs/capture-guide.md and docs/bootstrap-guide.md wording updated to match

Deliberately NOT renamed: the JSON key complies_with_guidelines itself, the
sheet column Complies_With_Guidelines?, and the 115 existing provider file
field names are unchanged — only descriptions/labels were corrected, to avoid
a coordinated rename across the sheet, bootstrap.py, and all provider files.
If a full rename is wanted later, that's separate follow-up work.

Additional context

Ready as a PR — just needs committing. All 71 existing tests pass unmodified
since only description/label text changed, not field names or schema
validity rules.

Checklist

I have identified the specific location in the docs
I have described what the correct content should be

### Where is the problem? schema/provider-schema-v2.3.json (provider.reviews.complies_with_guidelines and compliance_notes descriptions), tools/capture-form/index.html (Reviews step label), docs/capture-guide.md, docs/bootstrap-guide.md ### Type of problem Incorrect — the docs say something wrong ### What's wrong and what should it say? `complies_with_guidelines` and its label/description were worded as generic "scraping guidelines" compliance. The field is actually specifically about compliance with Trustpilot's Terms of Service (this is the reviews section — trustpilot_url, review_count, scrapes are all Trustpilot-scoped). Corrected wording has already been applied locally (not yet committed): - schema description → "Whether the review scrape complied with Trustpilot's Terms of Service. Null = not yet assessed." - compliance_notes description → references Trustpilot's ToS specifically, robots.txt kept as a secondary note - capture-form UI label → "Complies with Trustpilot's Terms of Service?" - docs/capture-guide.md and docs/bootstrap-guide.md wording updated to match Deliberately NOT renamed: the JSON key `complies_with_guidelines` itself, the sheet column `Complies_With_Guidelines?`, and the 115 existing provider file field names are unchanged — only descriptions/labels were corrected, to avoid a coordinated rename across the sheet, bootstrap.py, and all provider files. If a full rename is wanted later, that's separate follow-up work. ### Additional context Ready as a PR — just needs committing. All 71 existing tests pass unmodified since only description/label text changed, not field names or schema validity rules. ### Checklist - [x] I have identified the specific location in the docs - [x] I have described what the correct content should be

Xeplosion changed title from ~~Docs Update template~~ to Schema complaiance incorrect field documentation

2026-08-27 05:41:54 +00:00

Xeplosion closed this issue

2026-08-27 19:52:29 +00:00

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

XeplosionGames/minecraft-provider-analysis#8

No description provided.

Rows
Columns