From 7f909176f8e28eafe6b1a249a840661b65925884 Mon Sep 17 00:00:00 2001 From: Julien Maupetit Date: Thu, 20 Jun 2024 11:22:47 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(api)=20fix=20minor=20typos?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit French flag using the :fr: emoji code are not supported by gitbook, replaced them using the unicode character. Also don't forget to specify the language for a code block. --- docs/README.md | 2 +- docs/schemas.md | 6 +++--- docs/user/auth.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7c8c5a13..daa32af4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ QualiCharge developed an HTTP API to collect electric mobility-related data from focus on [EVSE](https://en.wikipedia.org/wiki/Charging_station) static (location, operator, etc.) and dynamic data (statuses and charging session) to provide **high-quality** and **up-to-date** datasets to our national access point: -https://transports.data.gouv.fr :fr: +https://transports.data.gouv.fr 🇫🇷 ## :loudspeaker: Choose your path diff --git a/docs/schemas.md b/docs/schemas.md index f3aa8956..1783e9e5 100644 --- a/docs/schemas.md +++ b/docs/schemas.md @@ -6,7 +6,7 @@ designed for static and dynamic EVSE-related data. ## Static data Static data relates to EVSEs metadata to describe them, _e.g._ their location, -accessibility, operator, etc. The data schema is documented (in French :fr:) here 👉 +accessibility, operator, etc. The data schema is documented (in French 🇫🇷) here 👉 [schema.data.gouv.fr/etalab/schema-irve-statique](https://schema.data.gouv.fr/etalab/schema-irve-statique/2.3.1/documentation.html). > :bulb: This schema will evolve in time as the European Commission is working on @@ -25,7 +25,7 @@ QualiCharge's API: - `id_station_itinerance`: similarly to `id_pdc_itinerance` this unique roaming-ready identifier applies for charging stations (not charge points). -The Qualicharge API **will not** accept \* nor any usual separator. Make sure to remove all separators before sending IDs through the API. +The Qualicharge API **will not** accept \* nor any usual separator. Make sure to remove all separators before sending IDs through the API. ## Dynamic data @@ -36,7 +36,7 @@ sessions (_aka_ sessions in the present documentation). When a charge point status changes, an event is emitted. This event may be serialized given the proposed standard we've adopted that is documented (in -French :fr:) at: +French 🇫🇷) at: [schema.data.gouv.fr/etalab/schema-irve-dynamique](https://schema.data.gouv.fr/etalab/schema-irve-dynamique/2.3.1/documentation.html). > :bulb: This standard may also evolve in a near future. Stay tuned! diff --git a/docs/user/auth.md b/docs/user/auth.md index 6dd993e0..f0e48e3a 100644 --- a/docs/user/auth.md +++ b/docs/user/auth.md @@ -104,7 +104,7 @@ your browser! Happy face :sunglasses: From your terminal, post your `username` and `password` to the `/api/v1/auth/token`: -``` +```bash curl -X POST \ --data-urlencode "username=USERNAME" \ --data-urlencode "password=PASSWORD" \ @@ -130,7 +130,7 @@ access token we will use in future authenticated API server requests: As an example implementation of how to use this token, we can use a little bit of Bash magic (:sweat_smile:) to store and use it: -```Bash +```bash # This variable will store our access token declare ACCESS_TOKEN