Skip to content

docs: expand photo.getByBounds reference - #80

Merged
aeifn merged 4 commits into
PastVu:mainfrom
thankfulfor:codex/photo-get-by-bounds-reference
Nov 19, 2026
Merged

aeifn merged 4 commits into
PastVu:mainfrom
thankfulfor:codex/photo-get-by-bounds-reference

Conversation

@thankfulfor

Copy link
Copy Markdown
Contributor

Summary

  • document the two photo.getByBounds modes controlled by localWork
  • add verified request and response examples for server-side clustering and direct lookup
  • describe response fields, coordinate order differences, year filtering, startAt, and errors
  • update English and Russian documentation

Checks

  • yarn lint:spelling
  • yarn build
  • git diff --check

By submitting this contribution, I agree to license it under CC BY 4.0.

@aeifn aeifn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found two API contract issues in photo.getByBounds that affect both the English and Russian references.

  1. [P2] Clarify what the polygon selects in cluster mode. With localWork: false, the server selects clusters by their grid position g. Near the polygon boundary, this can include photos outside the polygon or omit photos inside it. Make the object-level containment guarantee specific to localWork: true. Cluster queries
  2. [P2] Specify that the year filter matches the object's first year. Both modes filter on year alone. An object dated 1930–1940 is excluded by a request for 1936–1936 even though its date range overlaps the requested year. Direct lookup · Cluster lookup

@thankfulfor

Copy link
Copy Markdown
Contributor Author

Addressed both review points in 6f400f6. The reference now limits object-level polygon containment to localWork: true, explains that cluster mode selects cells by g, and states that the year filter matches the object’s first year only. Updated in both English and Russian.

@thankfulfor

Copy link
Copy Markdown
Contributor Author

Additional contract audit in 6835089 documents that direct lookup has no server-side limit or pagination and that z does not reduce the result set. Local checks and CI pass.

@aeifn
aeifn merged commit 0fb9925 into PastVu:main Nov 19, 2026
1 check passed
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.

2 participants