Skip to content
Permalink
Browse files

Minor docs improvements

  • Loading branch information...
joepio committed Aug 15, 2019
1 parent 48f49a0 commit bc43ab9df24e8478dd13b0ff4ce218056500c14d
Showing with 5 additions and 3 deletions.
  1. +5 −3 docs.md
@@ -11,11 +11,9 @@ The ORI API has several endpoints for different goals:
- the **REST API** for fetching individual resources
- an **Elastic** endpoint for full-text search

If you want to know how to query these endpoints, check out [`example_requests.http`](/example_requests.http).

### REST API

Endpoint: `https://id.openraadsinformatie.nl`
Endpoint: [`https://id.openraadsinformatie.nl`](https://id.openraadsinformatie.nl)

The ORI REST API is hofsted at the `id.openraadsinformatie.nl` subdomain.
Use this to get individual meetings / motions / agenda items / persons / etc, such as [`https://id.openraadsinformatie.nl/243815`](https://id.openraadsinformatie.nl/243815).
@@ -26,6 +24,8 @@ There is a special endpoint for getting all organizations: [`https://api.openraa

Read more about the REST API in its [github repo](https://github.com/ontola/ori_api) and its [documentation](https://id.openraadsinformatie.nl/).

If you want to see some examples of how to query this endpoint, check out [`example_requests.http`](/example_requests.http).

### Elastic

Endpoint: `https://api.openraadsinformatie.nl/v1/elastic/`
@@ -38,6 +38,8 @@ Read the [Elastic v7.0](https://www.elastic.co/guide/en/elasticsearch/reference/
Only specific Elastic features (endpoints) are publicly available.
This is to prevent (malicious or accidental) write / remove commands.

If you want to see some examples of how to query this endpoint, check out [`example_requests.http`](/example_requests.http).

## FAQ

### Who's behind this project?

0 comments on commit bc43ab9

Please sign in to comment.
You can’t perform that action at this time.