Skip to content

Commit 85fcd52

Browse files
Update Documentation with core changes (#128)
Co-authored-by: discoursebuild <[email protected]>
1 parent 88e0078 commit 85fcd52

File tree

2 files changed

+130
-0
lines changed

2 files changed

+130
-0
lines changed

openapi.json

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9879,6 +9879,86 @@
98799879
}
98809880
}
98819881
},
9882+
"/t/{id}/invite-group.json": {
9883+
"post": {
9884+
"summary": "Invite group to topic",
9885+
"tags": [
9886+
"Topics",
9887+
"Invites"
9888+
],
9889+
"operationId": "inviteGroupToTopic",
9890+
"parameters": [
9891+
{
9892+
"name": "Api-Key",
9893+
"in": "header",
9894+
"required": true,
9895+
"schema": {
9896+
"type": "string"
9897+
}
9898+
},
9899+
{
9900+
"name": "Api-Username",
9901+
"in": "header",
9902+
"required": true,
9903+
"schema": {
9904+
"type": "string"
9905+
}
9906+
},
9907+
{
9908+
"name": "id",
9909+
"in": "path",
9910+
"schema": {
9911+
"type": "string"
9912+
},
9913+
"required": true
9914+
}
9915+
],
9916+
"responses": {
9917+
"200": {
9918+
"description": "invites to a PM",
9919+
"content": {
9920+
"application/json": {
9921+
"schema": {
9922+
"type": "object",
9923+
"properties": {
9924+
"group": {
9925+
"type": "object",
9926+
"properties": {
9927+
"id": {
9928+
"type": "integer"
9929+
},
9930+
"name": {
9931+
"type": "string"
9932+
}
9933+
}
9934+
}
9935+
}
9936+
}
9937+
}
9938+
}
9939+
}
9940+
},
9941+
"requestBody": {
9942+
"content": {
9943+
"application/json": {
9944+
"schema": {
9945+
"type": "object",
9946+
"properties": {
9947+
"group": {
9948+
"type": "string",
9949+
"description": "The name of the group to invite"
9950+
},
9951+
"should_notify": {
9952+
"type": "boolean",
9953+
"description": "Whether to notify the group, it defaults to true"
9954+
}
9955+
}
9956+
}
9957+
}
9958+
}
9959+
}
9960+
}
9961+
},
98829962
"/t/{id}/bookmark.json": {
98839963
"put": {
98849964
"summary": "Bookmark topic",

openapi.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6973,6 +6973,56 @@ paths:
69736973
type: string
69746974
email:
69756975
type: string
6976+
"/t/{id}/invite-group.json":
6977+
post:
6978+
summary: Invite group to topic
6979+
tags:
6980+
- Topics
6981+
- Invites
6982+
operationId: inviteGroupToTopic
6983+
parameters:
6984+
- name: Api-Key
6985+
in: header
6986+
required: true
6987+
schema:
6988+
type: string
6989+
- name: Api-Username
6990+
in: header
6991+
required: true
6992+
schema:
6993+
type: string
6994+
- name: id
6995+
in: path
6996+
schema:
6997+
type: string
6998+
required: true
6999+
responses:
7000+
'200':
7001+
description: invites to a PM
7002+
content:
7003+
application/json:
7004+
schema:
7005+
type: object
7006+
properties:
7007+
group:
7008+
type: object
7009+
properties:
7010+
id:
7011+
type: integer
7012+
name:
7013+
type: string
7014+
requestBody:
7015+
content:
7016+
application/json:
7017+
schema:
7018+
type: object
7019+
properties:
7020+
group:
7021+
type: string
7022+
description: The name of the group to invite
7023+
should_notify:
7024+
type: boolean
7025+
description: Whether to notify the group, it defaults to true
69767026
"/t/{id}/bookmark.json":
69777027
put:
69787028
summary: Bookmark topic

0 commit comments

Comments
 (0)