Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(filter): improve description for selector id:(id list) #326

Merged
merged 1 commit into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Changelog

## 1.11.0-SNAPSHOT (current main)

### Other
* Fix filter documentation ([#326])

[#326]: https://github.com/GIScience/ohsome-api/pull/326


## 1.10.2

Expand Down
4 changes: 2 additions & 2 deletions docs/filter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ Selectors
| ``id:osm-type/osm-id`` | matches the entity with the given | ``id:node/1234`` |
| | osm type and id | |
+------------------------------------+------------------------------------+-----------------------------------+
| ``id:(id list)`` | matches all entities with the | ``id:(1, 42, 1234)`` |
| ``id:(osm-id list)`` | matches all entities with the | ``id:(1, 42, 1234)`` |
| | given osm ids [1]_ | |
+------------------------------------+------------------------------------+-----------------------------------+
| ``id:(id list)`` | matches all entities with the | ``id:(node/1, way/3)`` |
| ``id:(osm-type/osm-id list)`` | matches all entities with the | ``id:(node/1, way/3)`` |
| | given osm types and ids | |
+------------------------------------+------------------------------------+-----------------------------------+
| ``id:(id range)`` | matches all entities with an id | ``id:(1 .. 9999)`` |
Expand Down