From fd8fd0a1f0d21f5fd2c5b2bb93e32a6bb68f592e Mon Sep 17 00:00:00 2001 From: Blake Erickson Date: Mon, 24 Oct 2022 18:55:51 -0600 Subject: [PATCH] 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 --- spec/requests/api/groups_spec.rb | 2 +- .../schemas/json/group_create_request.json | 76 +++++++++++++++++++ 2 files changed, 77 insertions(+), 1 deletion(-) diff --git a/spec/requests/api/groups_spec.rb b/spec/requests/api/groups_spec.rb index 048c1f4e2c..fb58ae03d0 100644 --- a/spec/requests/api/groups_spec.rb +++ b/spec/requests/api/groups_spec.rb @@ -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' diff --git a/spec/requests/api/schemas/json/group_create_request.json b/spec/requests/api/schemas/json/group_create_request.json index 5be58664cf..bcbd237b78 100644 --- a/spec/requests/api/schemas/json/group_create_request.json +++ b/spec/requests/api/schemas/json/group_create_request.json @@ -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": [