discourse/spec/requests/api/schemas/json/group_create_request.json
Blake Erickson fd8fd0a1f0
DEV: Document create group api params (#18736)
* DEV: Document create group api params

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

* fix spelling
2022-10-24 18:55:51 -06:00

97 lines
2.1 KiB
JSON

{
"additionalProperties": false,
"properties": {
"group": {
"type": "object",
"additionalProperties": false,
"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": [
"name"
]
}
},
"required": [
"group"
]
}