docs: improve API documentation (changelog + readme files)

Documentation/API/CHANGELOG.md

@@ -5,12 +5,14 @@ All notable changes to API will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
 --------------------------------
 
 ## v1.2.0  (unreleased)
 
 ### Added
 
+- add `software -> license` (will replace  `software -> licence` in next major version)
 - add `data_date` (will replace  `date_of_export` in next major version)
 - add `data_statistics`
 - add `data_documentation -> license`
@@ -23,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `date_of_export` will be replaced by [ `data_date` ] in next major version
 - `number_of_software` will be replaced by [ `data_statistics -> software` ] in next major version
+- `software -> licence` will be replaced by [ `software -> license` ] in next major version
 
 
 --------------------------------
@@ -31,11 +34,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- add external ressources
-  - Wikipedia (software i18n slugs and URLs)
-  - WikiData (software ID and URL)
-  - FramaLibre (software slug and URL)
-  - SILL (software ID and i18n URLs)
+- add  `software -> external_resources`
+  - **Wikipedia** (software i18n slugs and URLs)
+  - **WikiData** (software ID and URL)
+  - **FramaLibre** (software slug and URL)
+  - **SILL** (software ID and i18n URLs)
+
 
 --------------------------------
 

Documentation/API/README.md

@@ -16,10 +16,46 @@ For each software, this **API** provides:
 - _Comptoir-du-libre.org_ ID and i18n URLs,
 - External resources:
   - **Wikipedia** (software i18n slugs and URLs),
-  - **WikiData** (software slug and URL),
+  - **WikiData** (software ID and URL),
   - **FramaLibre** (software slug and URL),
   - **SILL** (software ID and i18n URLs),
 - Providers:
   - Provider name,
   - Provider website,
   - _Comptoir-du-libre.org_ ID and URLs,
+
+
+Example:
+```json
+{
+  "api_documentation": {
+    "version": "1.2.0",
+    "changelog": "https://gitlab.adullact.net/Comptoir/Comptoir-srv/-/tree/develop/Documentation/API/CHANGELOG.md",
+    "documentation": "https://gitlab.adullact.net/Comptoir/Comptoir-srv/-/tree/develop/Documentation/API/",
+    "deprecated": {}
+  },
+  "data_documentation": {},
+  "data_statistics": {},
+  "data_date": "2022-12-07T16:19:40+00:00",
+  "softwares": [
+    {
+      "id": 72,
+      "name": "7-zip",
+      "url": "https://comptoir-du-libre.org/fr/softwares/72",
+      "i18n_url": {
+        "fr": "https://comptoir-du-libre.org/fr/softwares/72",
+        "en": "https://comptoir-du-libre.org/en/softwares/72"
+      },
+      "license": "GNU LGPL",
+      "created": "2017-02-07T22:46:57+00:00",
+      "modified": "2017-02-07T22:46:58+00:00",
+      "external_resources": {
+        "website": "http://www.7-zip.org/",
+        "repository": "https://github.com/pornel/7z.git",
+        "framalibre": {},
+        "sill":  {},
+        "wikidata":  {},
+        "wikipedia": {}
+      },
+      "provider": {}
+```