github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-01-18 21:02:48 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DEV: Document create group api params (#18736)

Browse Source 
* DEV: Document create group api params

Documenting more params that are available to the create group api
endpoint.

* fix spelling
This commit is contained in:
Blake Erickson 2022-10-24 18:55:51 -06:00 committed by GitHub
parent b6f5b236b3
commit fd8fd0a1f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 77 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spec/requests/api/groups_spec.rb
View File

@ -11,7 +11,7 @@ RSpec.describe 'groups' do
end
path '/admin/groups.json' do
post 'Creates a group' do
post 'Create a group' do
tags 'Groups'
operationId 'createGroup'
consumes 'application/json'

76
spec/requests/api/schemas/json/group_create_request.json
View File

@ -7,6 +7,82 @@
"properties": {
"name": {
"type": "string"
},
"full_name": {
"type": "string"
},
"bio_raw": {
"type": "string",
"description": "About Group"
},
"usernames": {
"type": "string",
"description": "comma,separated"
},
"owner_usernames": {
"type": "string",
"description": "comma,separated"
},
"automatic_membership_email_domains": {
"type": "string",
"description": "pipe|separated"
},
"visibility_level": {
"type": "integer"
},
"primary_group": {
"type": "boolean"
},
"flair_icon": {
"type": "string"
},
"flair_upload_id": {
"type": "integer"
},
"flair_bg_color": {
"type": "string"
},
"public_admission": {
"type": "boolean"
},
"public_exit": {
"type": "boolean"
},
"public_exit": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"muted_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"regular_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"watching_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"tracking_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"watching_first_post_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [