commit 267fab55002f685b65dd4d6b13885d42a0a763e8
author Dave Brondsema <dbrondsema@slashdotmedia.com> Thu May 02 13:15:15 2024 -0400
committer Dave Brondsema <dbrondsema@slashdotmedia.com> Thu May 02 13:15:15 2024 -0400
tree 1c755100f064887a833d3080f328721980e6ab12
parent 91d39a1e72ce4cb10c6bcf7b675f67ce2d171cdb

[#8559] update API docs for ticket endpoints

Allura/docs/api-rest/api.raml

diff --git a/Allura/docs/api-rest/api.raml b/Allura/docs/api-rest/api.raml
index 8574205..dd655cf 100755
--- a/Allura/docs/api-rest/api.raml
+++ b/Allura/docs/api-rest/api.raml
@@ -272,10 +272,6 @@
               body:
                 application/x-www-form-urlencoded:
                   formParameters:
-                    access_token:
-                      description: "The access token provided by the authentication application"
-                      required: true
-                      type: string
                     ticket_form.summary:
                       description: Ticket title
                       type: string
@@ -284,6 +280,10 @@
                       description: ticket description
                       type: string
                       required: false
+                    ticket_form.status:
+                      description: ticket status
+                      type: string
+                      required: false
                     ticket_form.assigned_to:
                       type: string
                       required: false
@@ -296,8 +296,16 @@
                       type: file
                       description:  (optional) attachment
                       required: false
-                    ticket_form.custom-field-name:
-                      description:  custom field value
+                    ticket_form.custom_fields._any-field-name:
+                      description: Starts with underscore, and must conform to the custom fields set up for this tracker.  "true" or "false" values will work for boolean custom fields.
+                      type: string
+                      required: false
+                    ticket_form.private:
+                      description: if the ticket is private or not ("true" or "false")
+                      type: string
+                      required: false
+                    ticket_form.discussion_disabled:
+                      description: if comments may be posted on the ticket ("true" or "false")
                       type: string
                       required: false
 
@@ -320,10 +328,6 @@
             body:
               application/x-www-form-urlencoded:
                 formParameters:
-                  access_token:
-                    description: "The access token provided by the authentication application"
-                    required: true
-                    type: string
                   ticket_form.summary:
                     description: Ticket title
                     type: string
@@ -332,6 +336,10 @@
                     description: ticket description
                     type: string
                     required: false
+                  ticket_form.status:
+                    description: ticket status
+                    type: string
+                    required: false
                   ticket_form.assigned_to:
                     type: string
                     required: false
@@ -344,8 +352,16 @@
                     type: file
                     description: (optional) attachment
                     required: false
-                  ticket_form.custom_field_name:
-                    description: custom field value
+                  ticket_form.custom_fields._any-field-name:
+                    description: Starts with underscore, and must conform to the custom fields set up for this tracker.  "true" or "false" values will work for boolean custom fields.
+                    type: string
+                    required: false
+                  ticket_form.private:
+                    description: if the ticket is private or not ("true" or "false")
+                    type: string
+                    required: false
+                  ticket_form.discussion_disabled:
+                    description: if comments may be posted on the ticket ("true" or "false")
                     type: string
                     required: false