Added : Arduino projects endpoint

Author: Exybore

CHANGELOG.md

@@ -1,5 +1,9 @@
 # 🕓 Change log
 
+## Added : Arduino projects endpoint
+
+**April 9, 2019 :** The API now includes the future Arduino projects hub. [Details](resources/Arduino.md)
+
 ## Changed : Optional fields
 
 **April 9, 2019 :** All the fields in some PATCH requests are now optional, meaning that you can only include fields that you're going to edit.
@@ -14,7 +18,7 @@
 
 ## Added : Get user's permissions
 
-**January 5, 2018 :** getting user's permissions is now in `/users/{username/permissions` and requires `USER_WRITE` permission. [Details](users/Endpoint.md#get-users-permissions)
+**January 5, 2018 :** getting user's permissions is now in `/users/{username/permissions` and requires `USER_WRITE` permission. [Details](resources/User.md#get-users-permissions)
 
 **Affecting :** [Get user](resources/User.md#get-user)
 

README.md

@@ -18,3 +18,4 @@ Every response is in JSON format, and has in its body a `code` which is `1` or `
 - **Resources**
   - [Post](resources/Post.md)
   - [User](resources/User.md)
+  - [Arduino](resources/Arduino.md)

resources/Arduino.md

@@ -0,0 +1,68 @@
+# 🔌 Arduino resource
+
+All the Arduino projects from the [projects hub](https://arduino.becauseofprog.fr) are in this endpoint.
+
+### Arduino project object
+
+| Field         | Type                               | Description                        | Can be null ? |
+| ------------- | ---------------------------------- | ---------------------------------- | ------------- |
+| url           | string                             | project's URL                      |               |
+| author        | [user object](User.md#user-object) | project's author                   |               |
+| name          | string                             | project's name                     |               |
+| summary       | string                             | project's summary                  |               |
+| illustration  | string                             | picture to illustrate project      | ✅            |
+| video         | string                             | video to illustrate project        | ✅            |
+| link          | string                             | link to further informations       | ✅            |
+| description   | string                             | project's description              | ✅            |
+| timestamp     | int                                | unix timestamp, project's creation |               |
+| is_from_staff | boolean                            | if the project is from the staff   |               |
+| is_featured   | boolean                            | if the project is featured         |               |
+
+## Get all projects
+
+`GET /arduino-projects`
+
+Get all the projects. Returns a `data` list with [arduino project objects](#arduino-project-object) inside.
+
+## Create project
+
+`POST /arduino-projects`
+
+Create a new Arduino project. Requires auth.
+
+### Required data
+
+| Field   | Type   | Description       |
+| ------- | ------ | ----------------- |
+| url     | string | project's URL     |
+| name    | string | project's name    |
+| summary | string | project's summary |
+
+### Optional data
+
+| Field        | Type   | Description                   |
+| ------------ | ------ | ----------------------------- |
+| illustration | string | picture to illustrate project |
+| video        | string | video to illustrate project   |
+| link         | string | link to further informations  |
+| description  | string | project's description         |
+
+## Get project
+
+`GET /arduino-projects/{arduino-project.url}`
+
+Get one project by its URL. Returns a [arduino project object](#arduino-project-object) called `data`.
+
+## Edit project
+
+`PATCH /arduino-projects/{arduino-project.url}`
+
+Edit a prokect. Requires auth and to be the project's author.
+
+**Editable fields :** `name`, `summary`, `illustration`, `video`, `link`, `description`.
+
+## Delete project
+
+`DELETE /arduino-projects/{arduino-project.url}`
+
+Delete a project. Requires auth and to be the project's author.