Merge pull request #15986 from opf/fix/additional_docs_on_news_api

additional docs on news api
opf · Jul 1, 2024 · 743ac49 · 743ac49
2 parents 018a2e4 + 68fe020
commit 743ac49
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 3 deletions.
diff --git a/docs/api/apiv3/components/schemas/list_of_news_model.yml b/docs/api/apiv3/components/schemas/list_of_news_model.yml
@@ -37,6 +37,12 @@ example:
         author:
           href: "/api/v3/users/2"
           title: Peggie Feeney
+        updateImmediately:
+          href: "api/v3/news/1"
+          method: "patch"
+        delete:
+          href: "api/v3/news/1"
+          method: "delete"
     - _type: News
       id: 2
       title: terminatio tutamen. Officia adeptio sp
@@ -62,6 +68,12 @@ example:
         author:
           href: "/api/v3/users/2"
           title: Peggie Feeney
+        updateImmediately:
+          href: "api/v3/news/2"
+          method: "patch"
+        delete:
+          href: "api/v3/news/2"
+          method: "delete"
   _links:
     self:
       href: "/api/v3/news?offset=1&pageSize=2"

diff --git a/docs/api/apiv3/components/schemas/news_create_model.yml b/docs/api/apiv3/components/schemas/news_create_model.yml
@@ -27,7 +27,6 @@ properties:
 
               **Resource**: Project
 example:
-  _type: News
   title: asperiores possimus nam doloribus ab
   summary: Celebrer spiculum colo viscus claustrum atque. Id nulla culpa sumptus.
     Comparo crapula depopulo demonstro.

diff --git a/docs/api/apiv3/components/schemas/news_model.yml b/docs/api/apiv3/components/schemas/news_model.yml
@@ -54,6 +54,20 @@ properties:
 
             **Resource**: User
           readOnly: true
+      updateImmediately:
+        allOf:
+          - "$ref": "./link.yml"
+          - description: |-
+              Directly perform edits on the news
+
+              **Permission** manage news
+      delete:
+        allOf:
+          - "$ref": "./link.yml"
+          - description: |-
+              Delete the news
+
+              **Permission** manage news
 example:
   _type: News
   id: 1
@@ -83,6 +97,12 @@ example:
     author:
       href: "/api/v3/users/2"
       title: Peggie Feeney
+    updateImmediately:
+      href: "api/v3/news/1"
+      method: "patch"
+    delete:
+      href: "api/v3/news/1"
+      method: "delete"
   _embedded:
     project:
       _type: Project...

diff --git a/docs/api/apiv3/paths/news_item.yml b/docs/api/apiv3/paths/news_item.yml
@@ -96,7 +96,7 @@ patch:
     content:
       application/json:
         schema:
-          $ref: '../components/schemas/news_model.yml'
+          $ref: '../components/schemas/news_create_model.yml'
   responses:
     '200':
       content:

diff --git a/docs/api/apiv3/tags/news.yml b/docs/api/apiv3/tags/news.yml
@@ -4,7 +4,10 @@ description: |-
 
   ## Actions
 
-  None yet
+  | Link                | Description                                                              | Condition                              |
+  |:-------------------:|--------------------------------------------------------------------------| ---------------------------------------|
+  | delete              | Delete the new                                                           | **Permission**: manage news            |
+  | updateImmediately   | Directly perform edits on the news                                       | **Permission**: manage news            |
 
   ## Linked Properties