Repository: allura
Updated Branches:
  refs/heads/master 67b553ce2 -> 502b5e442


Fix RAML syntax (queryRequired wasn't coming through as bool in the type def), 
other minor tweaks


Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/502b5e44
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/502b5e44
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/502b5e44

Branch: refs/heads/master
Commit: 502b5e442662198f831201e8010902b31b5201bd
Parents: 67b553c
Author: Dave Brondsema <d...@brondsema.net>
Authored: Wed Sep 28 11:46:31 2016 -0400
Committer: Dave Brondsema <d...@brondsema.net>
Committed: Wed Oct 12 10:53:18 2016 -0400

----------------------------------------------------------------------
 Allura/docs/api-rest/api.raml           | 3 +--
 Allura/docs/api-rest/docs.md            | 4 ++--
 Allura/docs/api-rest/resourceTypes.yaml | 2 +-
 3 files changed, 4 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/allura/blob/502b5e44/Allura/docs/api-rest/api.raml
----------------------------------------------------------------------
diff --git a/Allura/docs/api-rest/api.raml b/Allura/docs/api-rest/api.raml
index 3e95058..f53de14 100755
--- a/Allura/docs/api-rest/api.raml
+++ b/Allura/docs/api-rest/api.raml
@@ -242,7 +242,7 @@ documentation:
                       type: file
                       description:  (optional) attachment
                       required: false
-                    ticket_form.custom field name:
+                    ticket_form.custom-field-name:
                       description:  custom field value
                       type: string
                       required: false
@@ -252,7 +252,6 @@ documentation:
             searchableCollection: {
               queryParamName: q,
               queryParamExample: 'example',
-              queryRequired: true,
               schema: !include schemas/searchedTickets.json,
               example: !include examples/searchedTickets.json
             }

http://git-wip-us.apache.org/repos/asf/allura/blob/502b5e44/Allura/docs/api-rest/docs.md
----------------------------------------------------------------------
diff --git a/Allura/docs/api-rest/docs.md b/Allura/docs/api-rest/docs.md
index 246fe3c..fe03e8c 100755
--- a/Allura/docs/api-rest/docs.md
+++ b/Allura/docs/api-rest/docs.md
@@ -56,14 +56,14 @@ Simple URL example to access a private ticket:
 
 
https://forge-allura.apache.org/rest/p/allura/tickets/35/?access_token=MY_BEARER_TOKEN
 
-Python code example:
+Python code example to create a new ticket:
 
     import requests
     from pprint import pprint
     
     BEARER_TOKEN = '<bearer token from oauth page>'
     
-    r = 
requests.post('https://forge-allura.apache.org/rest/p/test-project/new', 
params={
+    r = 
requests.post('https://forge-allura.apache.org/rest/p/test-project/tickets/new',
 params={
             'access_token': BEARER_TOKEN,
             'ticket_form.summary': 'Test ticket',
             'ticket_form.description': 'This is a test ticket',

http://git-wip-us.apache.org/repos/asf/allura/blob/502b5e44/Allura/docs/api-rest/resourceTypes.yaml
----------------------------------------------------------------------
diff --git a/Allura/docs/api-rest/resourceTypes.yaml 
b/Allura/docs/api-rest/resourceTypes.yaml
index f6324de..fca9fa7 100755
--- a/Allura/docs/api-rest/resourceTypes.yaml
+++ b/Allura/docs/api-rest/resourceTypes.yaml
@@ -73,7 +73,7 @@
         <<queryParamName>>:
           description: Return <<resourcePathName>> that have their 
<<queryParamName>> matching the given value
           example: <<queryParamExample>>
-          required: <<queryRequired>>
+          required: true
       responses:
         200:
           body:

Reply via email to