Skip to content

docs(obligations): add geocoding feedback #166

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.

Sign up for GitHub

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

Merged
shimoncohen merged 1 commit into from
Jun 10, 2026
Merged

docs(obligations): add geocoding feedback #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 18 additions & 6 deletions docs/MapColonies/obligations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,23 @@ tags:

Here we detail the must-haves for every application that wishes to work with our services.

### Application Startup
# General

## Application Startup

When your application is loaded or refreshed you are required make a request to our `catalogue` services in order to fetch **up-to-date information**. Caching the request may result in errors due to changed metadata and links, new products or even deleted products that don't exist anymore.

### Catalog items
## Catalog items

In order to use our services you are required to go through the catalogue. The `catalogue` is the gateway to many of our services, it details the available `products` and `product metadata` for a particular domain.

### Hardcoded Links
## Pagination

Some of our services return multiple results per request, according to filter parameters, and due to geographic entities the returned payload may be very large. In order to solve this issue we implement `pagination` using special parameters.

You should be using `pagination` in order to control the amount of results returned and easily split a request that yields a huge amount of data or records in to multiple requests. Read more in the documentation page for each service in order to understand how to use this feature.

## Hardcoded Links

We require that you fetch and extract any link that is available in our `catalogue services` through your code.<br/>
Any link that **isn't available** through the catalogue service may be held as an **easily configurable** parameter.
Expand All @@ -33,6 +41,10 @@ Any link that **isn't available** through the catalogue service may be held as a
We hold the right to change any link that is available through our catalogue services at any time.
:::

# Domain specific

## Raster

### Basemaps

At application startup there is usually a set of default Raster layers that are displayed.
Expand All @@ -41,8 +53,8 @@ in case you want to use different layers in the future.

We also recommend that the layers are loaded in the same order as described in the list for easy swapping.

### Pagination
## Vector

Some of our services return multiple results per request, according to filter parameters, and due to geographic entities the returned payload may be very large. In order to solve this issue we implement `pagination` using special parameters.
### Using Feedback API with Geocoding

You should be using `pagination` in order to control the amount of results returned and easily split a request that yields a huge amount of data or records in to multiple requests. Read more in the documentation page for each service in order to understand how to use this feature.
While interacting with Geocoding API, for BI purposes and to better understand our users's needs and interests, for each response sent from Geocoding API, we require the users to provide 'feedback' on our response by using Geocoding's [`Feedback API`](/docs/MapColonies/vector/Services/geocoding/feedback).
Loading