[TikiWiki-commits] [Git][tikiwiki/tiki][master] [DOC] Wiki API: add Swagger documentation for PATCH /wiki/page/{page}

Victor Emanouilov pushed to branch master at Tiki Wiki CMS Groupware / Tiki


Commits:
63d43f63 by Bsfez at 2026-06-22T09:47:14+00:00
[DOC] Wiki API: add Swagger documentation for PATCH /wiki/page/{page}

- - - - -


3 changed files:

- templates/api/docs/paths/wiki/entity.yaml
- + templates/api/docs/schemas/WikiPatchPageRequest.yaml
- templates/api/docs/schemas/WikiPatchPageResponse.yaml


Changes:

=====================================
templates/api/docs/paths/wiki/entity.yaml
=====================================
@@ -42,6 +42,40 @@ post:
                 $ref: schemas-WikiPageResponse.yaml
     '403':
       description: forbidden
+      content:
+        application/json:
+          schema:
+            $ref: schemas-Error.yaml
+patch:
+  description: Partially update a wiki page (SEO title, description, categories, tags)
+  parameters:
+    - name: page
+      in: path
+      description: Page name
+      required: true
+      schema:
+        type: string
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: schemas-WikiPatchPageRequest.yaml
+  responses:
+    '200':
+      description: patch response
+      content:
+        application/json:
+          schema:
+            $ref: schemas-WikiPatchPageResponse.yaml
+    '403':
+      description: forbidden
+      content:
+        application/json:
+          schema:
+            $ref: schemas-Error.yaml
+    '404':
+      description: page not found
       content:
         application/json:
           schema:


=====================================
templates/api/docs/schemas/WikiPatchPageRequest.yaml
=====================================
@@ -0,0 +1,19 @@
+---
+type: object
+properties:
+  seo_title:
+    type: string
+    description: Content of the SEO title tag, used for search engine optimization (max 160 characters)
+  seo_description:
+    type: string
+    description: Page meta description used for search engine optimization (max 200 characters)
+  categories:
+    type: array
+    items:
+      type: integer
+    description: Full replacement list of category IDs assigned to the page
+  tags:
+    type: array
+    items:
+      type: string
+    description: Full replacement list of freetags assigned to the page. Multi-word tags are supported.


=====================================
templates/api/docs/schemas/WikiPatchPageResponse.yaml
=====================================
@@ -12,3 +12,5 @@ properties:
     type: string
   updated_fields:
     type: array
+    items:
+      type: string



View it on GitLab: https://gitlab.com/tikiwiki/tiki/-/commit/63d43f63c33f16bb04d38e3189a2dd24258502e2

-- 
View it on GitLab: https://gitlab.com/tikiwiki/tiki/-/commit/63d43f63c33f16bb04d38e3189a2dd24258502e2
You're receiving this email because of your account on gitlab.com. Manage all notifications: https://gitlab.com/-/profile/notifications | Help: https://gitlab.com/help

_______________________________________________
TikiWiki-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-cvs