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.

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

📝(api) fix minor typos #100

Merged
merged 1 commit into from
Jun 20, 2024
Merged

📝(api) fix minor typos #100

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/schemas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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!
Expand Down
4 changes: 2 additions & 2 deletions docs/user/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand All @@ -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

Expand Down
Loading