Skip to content
Permalink
Browse files

Add docs for versioning, edit home for ORI

  • Loading branch information
joepio committed Jan 15, 2020
1 parent 155ddb5 commit 3d7c2060cbe405be51774510242bd4a48d9da22d
Showing with 19 additions and 9 deletions.
  1. +12 −2 docs.md
  2. +1 −1 front/package.json
  3. +1 −1 front/public/index.html
  4. +2 −2 front/public/site.webmanifest
  5. +3 −1 front/src/Components/Home.tsx
  6. +0 −2 oriapi.http
14 docs.md
@@ -41,7 +41,17 @@ If you want to know the mapping for Elastic, visit `https://api.openraadsinforma

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

## Changes from V0
## API Versioning & deprecation

APIs change over time, and some of these changes could break implementations.
At all times, we try to minimize these breaking changes.
When these are necessary, however, we will upgrade the API version.
If you want to receive notifications prior to breaking API changes, subscribe by mailing to [joep@argu.co](mailto:joep@argu.co?subject=ORI API versioning) with the subject: "ORI API versioning".

- The REST API should be considered stable.
- The Elastic API has various undocument endpoints.

### Changes from V0 to V1

- ElasticSearch was upgraded from 5 to 7 ([upgrade guide](https://www.elastic.co/guide/en/cloud/current/ec-upgrading-v7.html))
- Events are now split between "Meetings" and "AgendaItems"
@@ -66,7 +76,7 @@ In the future, we hope to use the [VNG Open Raadsinformatie spec](https://github

### Who uses ORI / these APIs?

- [Ori-search](http://ori.argu.co), the official ORI search interface
- [OpenBesluitvorming.nl](https://openbesluitvorming.nl), the new search interface
- [1848.nl](https://1848.nl), which features a notification system (contact: Lucas Benschop)
- [WaarOverheid](https://waaroverheid.nl/), a location based app to navigate, search and subscribe to ORI data (contact: Alex Olieman)
- [Argu.co](https://argu.co), an e-democracy platform for civic engagement (contact: [Joep Meindertsma](mailto:joep@argu.co))
@@ -8,7 +8,7 @@
"bugs": "https://github.com/ontola/ori-search/issues",
"homepage": "https://ori.argu.co",
"repository": "github:ontola/ori-search",
"description": "Search interface for Open Raadsinformatie",
"description": "Search interface for Open Raadsinformatie & Stateninformatie",
"private": true,
"dependencies": {
"@appbaseio/reactivesearch": "^3.0.3",
@@ -30,7 +30,7 @@
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>Open Raadsinformatie</title>
<title>OpenBesluitvorming.nl</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
@@ -1,6 +1,6 @@
{
"name": "Open Raadsinformatie",
"short_name": "Open Raadsinformatie",
"name": "OpenBesluitvorming.nl",
"short_name": "OpenBesluitvorming.nl",
"icons": [
{
"src": "/android-chrome-192x192.png",
@@ -102,7 +102,9 @@ const Home = () => {
<p>
Als je wil dat ook jouw gemeente aangesloten wordt op Open Raadsinformatie,
vraag dan de griffie van je gemeenteraad <a href={paths.vngNewForm}>dit formulier</a> in te vullen.
<span> Provincies of andere overheden kunnen mailen naar <a href={paths.arguMail}>joep@argu.co</a>.</span>
{IS_ORI &&
<span> Provincies of andere overheden kunnen mailen naar <a href={paths.arguMail}>joep@argu.co</a>.</span>
}
</p>
<h2>Andere apps</h2>
<ul>

This file was deleted.

0 comments on commit 3d7c206

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