api(collections): Return the publication_frequency_per_year attribute

Author: marienfressinaud

docs/api/collections.md

@@ -27,15 +27,17 @@ $ curl -H "Content-Type: application/json" \
         "description": "",
         "group": null,
         "is_public": false,
-        "is_followed": false
+        "is_followed": false,
+        "publication_frequency_per_year": 4
     },
     {
         "id": "1833740002944268171",
         "name": "My shares",
         "description": "",
         "group": null,
         "is_public": true,
-        "is_followed": false
+        "is_followed": false,
+        "publication_frequency_per_year": 42
     }
 ]
 ```
@@ -51,7 +53,7 @@ $ curl -H "Content-Type: application/json" \
 ### Changelog
 
 - 2.0.0: added
-- 2.0.5: `is_followed` attribute added
+- 2.0.5: `is_followed` and `publication_frequency_per_year` attributes added
 
 ## Create a collection
 
@@ -86,7 +88,8 @@ $ curl -H "Content-Type: application/json" \
     "description": "The description",
     "group": null,
     "is_public": true,
-    "is_followed": false
+    "is_followed": false,
+    "publication_frequency_per_year": 0
 }
 ```
 
@@ -125,7 +128,7 @@ $ curl -H "Content-Type: application/json" \
 ### Changelog
 
 - 2.0.0: added
-- 2.0.5: `is_followed` attribute added
+- 2.0.5: `is_followed` and `publication_frequency_per_year` attributes added
 
 ## Get a collection
 
@@ -153,7 +156,8 @@ $ curl -H "Content-Type: application/json" \
     "description": "The description",
     "group": null,
     "is_public": true,
-    "is_followed": false
+    "is_followed": false,
+    "publication_frequency_per_year": 0
 }
 ```
 
@@ -184,7 +188,7 @@ $ curl -H "Content-Type: application/json" \
 ### Changelog
 
 - 2.0.0: added
-- 2.0.5: `is_followed` attribute added
+- 2.0.5: `is_followed` and `publication_frequency_per_year` attributes added
 
 ## Update a collection
 
@@ -219,7 +223,8 @@ $ curl -H "Content-Type: application/json" \
     "description": "The description",
     "group": null,
     "is_public": false,
-    "is_followed": false
+    "is_followed": false,
+    "publication_frequency_per_year": 0
 }
 ```
 
@@ -274,7 +279,7 @@ $ curl -H "Content-Type: application/json" \
 ### Changelog
 
 - 2.0.0: added
-- 2.0.5: `is_followed` attribute added
+- 2.0.5: `is_followed` and `publication_frequency_per_year` attributes added
 
 ## Delete a collection
 

docs/api/search.md

@@ -52,7 +52,8 @@ $ curl -H "Content-Type: application/json" \
             "url": "https://flus.fr/carnet/feeds/all.atom.xml",
             "type": "atom",
             "site_url": "https://flus.fr/carnet/",
-            "is_followed": false
+            "is_followed": false,
+            "publication_frequency_per_year": 24
         }
     ]
 }

src/models/Collection.php

@@ -431,6 +431,7 @@ public function toJson(User $context_user): array
                 'type' => $this->feed_type,
                 'site_url' => $this->feed_site_url,
                 'is_followed' => $context_user->isFollowing($this->id),
+                'publication_frequency_per_year' => $this->publication_frequency_per_year,
             ];
         } else {
             return [
@@ -440,6 +441,7 @@ public function toJson(User $context_user): array
                 'group' => $this->groupForUser($context_user->id)?->name,
                 'is_public' => $this->is_public,
                 'is_followed' => $context_user->isFollowing($this->id),
+                'publication_frequency_per_year' => $this->publication_frequency_per_year,
             ];
         }
     }