Update Documentation with core changes (#128)

Co-authored-by: discoursebuild <[email protected]>
discourse · Nov 14, 2024 · 85fcd52 · 85fcd52
1 parent 88e0078
commit 85fcd52
Show file tree

Hide file tree

Showing 2 changed files with 130 additions and 0 deletions.
diff --git a/openapi.json b/openapi.json
@@ -9879,6 +9879,86 @@
         }
       }
     },
+    "/t/{id}/invite-group.json": {
+      "post": {
+        "summary": "Invite group to topic",
+        "tags": [
+          "Topics",
+          "Invites"
+        ],
+        "operationId": "inviteGroupToTopic",
+        "parameters": [
+          {
+            "name": "Api-Key",
+            "in": "header",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "Api-Username",
+            "in": "header",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "invites to a PM",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "group": {
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "type": "integer"
+                        },
+                        "name": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "group": {
+                    "type": "string",
+                    "description": "The name of the group to invite"
+                  },
+                  "should_notify": {
+                    "type": "boolean",
+                    "description": "Whether to notify the group, it defaults to true"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/t/{id}/bookmark.json": {
       "put": {
         "summary": "Bookmark topic",

diff --git a/openapi.yml b/openapi.yml
@@ -6973,6 +6973,56 @@ paths:
                   type: string
                 email:
                   type: string
+  "/t/{id}/invite-group.json":
+    post:
+      summary: Invite group to topic
+      tags:
+      - Topics
+      - Invites
+      operationId: inviteGroupToTopic
+      parameters:
+      - name: Api-Key
+        in: header
+        required: true
+        schema:
+          type: string
+      - name: Api-Username
+        in: header
+        required: true
+        schema:
+          type: string
+      - name: id
+        in: path
+        schema:
+          type: string
+        required: true
+      responses:
+        '200':
+          description: invites to a PM
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  group:
+                    type: object
+                    properties:
+                      id:
+                        type: integer
+                      name:
+                        type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                group:
+                  type: string
+                  description: The name of the group to invite
+                should_notify:
+                  type: boolean
+                  description: Whether to notify the group, it defaults to true
   "/t/{id}/bookmark.json":
     put:
       summary: Bookmark topic