From f78ea9926bd2fa623bb0e1e1dbb9d68690ed6a14 Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Tue, 25 Oct 2022 18:24:54 -0600
Subject: [PATCH] DEV: Add description for active param on create user api docs
 (#18753)

The `active` param on the create user endpoint requires that an api key
is used in the request header otherwise it is ignored, so adding this
distinction to the api docs.
---
 spec/requests/api/schemas/json/user_create_request.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/spec/requests/api/schemas/json/user_create_request.json b/spec/requests/api/schemas/json/user_create_request.json
index ac5fc3265f..92990832e5 100644
--- a/spec/requests/api/schemas/json/user_create_request.json
+++ b/spec/requests/api/schemas/json/user_create_request.json
@@ -14,7 +14,8 @@
       "type": "string"
     },
     "active": {
-      "type": "boolean"
+      "type": "boolean",
+      "description": "This param requires an api key in the request header or it will be ignored"
     },
     "approved": {
       "type": "boolean"