This is an automated email from the ASF dual-hosted git repository.
brondsem pushed a commit to branch db/8468
in repository https://gitbox.apache.org/repos/asf/allura.git
commit d9d0b79d883c0a270490a4e5af3d9e0020fb257d
Author: Dave Brondsema <dbronds...@slashdotmedia.com>
AuthorDate: Thu Sep 22 13:03:02 2022 -0400
[#8468] RAML ugprade WORK IN PROGRESS
---
Allura/docs/api-rest/api.raml | 2 +-
Allura/docs/api-rest/resourceTypes.yaml | 14 +++++++-------
Allura/docs/api-rest/schemas/discussion.json | 4 ++--
Allura/docs/api-rest/schemas/tickets.json | 2 +-
Allura/docs/api-rest/securitySchemes.yaml | 2 +-
Allura/docs/api-rest/traits.yaml | 10 +++++-----
6 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/Allura/docs/api-rest/api.raml b/Allura/docs/api-rest/api.raml
index 85742059d..11099f11d 100755
--- a/Allura/docs/api-rest/api.raml
+++ b/Allura/docs/api-rest/api.raml
@@ -1,4 +1,4 @@
-#%RAML 0.8
+#%RAML 1.0
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
diff --git a/Allura/docs/api-rest/resourceTypes.yaml
b/Allura/docs/api-rest/resourceTypes.yaml
index fca9fa77c..c2519f94e 100755
--- a/Allura/docs/api-rest/resourceTypes.yaml
+++ b/Allura/docs/api-rest/resourceTypes.yaml
@@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.
-- base:
+base:
get?:
responses: &standardResponses # yaml syntax to alias properties
200:
@@ -30,11 +30,11 @@
description: Created
delete?:
responses: *standardResponses
-- collection:
+collection:
type: base
get:
is: [ pageable, bearerAuth ]
-- generic:
+generic:
# this is really just a shorthand for us when we have a schema & example
# so we couldn't come up with a good name and picked something generic :)
type: base
@@ -66,7 +66,7 @@
application/json:
schema: <<schema>>
delete?:
-- searchableCollection:
+searchableCollection:
get:
is: [ bearerAuth ]
queryParameters:
@@ -80,7 +80,7 @@
application/json:
schema: <<schema>>
example: <<example>>
-- typedCollection:
+typedCollection:
type: collection
get:
responses:
@@ -89,12 +89,12 @@
application/json:
schema: <<schema>>
example: <<example>>
-- permission:
+permission:
description: |
Checks if a given user has permissions.
get:
is: [permissionTestable, bearerAuth]
-- project:
+project:
type: base
get:
responses:
diff --git a/Allura/docs/api-rest/schemas/discussion.json
b/Allura/docs/api-rest/schemas/discussion.json
index 5a66073e8..43e237008 100755
--- a/Allura/docs/api-rest/schemas/discussion.json
+++ b/Allura/docs/api-rest/schemas/discussion.json
@@ -33,7 +33,7 @@
"id": "_id"
},
"last_post": {
- "type": "object",
+ "type": ["object", "null"],
"id": "last_post",
"properties": {
"status": {
@@ -41,7 +41,7 @@
"id": "status"
},
"last_edited": {
- "type": "null",
+ "type": ["string", "null"],
"id": "last_edited"
},
"author": {
diff --git a/Allura/docs/api-rest/schemas/tickets.json
b/Allura/docs/api-rest/schemas/tickets.json
index a30e01c74..e8df259e1 100755
--- a/Allura/docs/api-rest/schemas/tickets.json
+++ b/Allura/docs/api-rest/schemas/tickets.json
@@ -46,7 +46,7 @@
},
"default": {
"id": "default",
- "type": "string"
+ "type": ["string", "boolean"],
},
"description": {
"id": "description",
diff --git a/Allura/docs/api-rest/securitySchemes.yaml
b/Allura/docs/api-rest/securitySchemes.yaml
index 194b5f71a..3f1156e6b 100755
--- a/Allura/docs/api-rest/securitySchemes.yaml
+++ b/Allura/docs/api-rest/securitySchemes.yaml
@@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.
-- oauth_1_0:
+oauth_1_0:
description: |
OAuth 1.0 may be used to authenticate API requests.
diff --git a/Allura/docs/api-rest/traits.yaml b/Allura/docs/api-rest/traits.yaml
index d3f17a4f7..52e18c044 100755
--- a/Allura/docs/api-rest/traits.yaml
+++ b/Allura/docs/api-rest/traits.yaml
@@ -15,14 +15,14 @@
# specific language governing permissions and limitations
# under the License.
-- searchable:
+searchable:
queryParameters:
query:
description: |
JSON array
[{"field1","value1","operator1"},{"field2","value2","operator2"},...,{"fieldN","valueN","operatorN"}]
<<description>>
example: |
<<example>>
-- orderable:
+orderable:
queryParameters:
orderBy:
description: |
@@ -34,7 +34,7 @@
enum: [desc, asc]
default: desc
required: false
-- pageable:
+pageable:
queryParameters:
page:
description: Skip over a number of elements by specifying a starting
page
@@ -48,7 +48,7 @@
required: false
example: 10
default: 25
-- permissionTestable:
+permissionTestable:
description: |
**Endpoints**
Permissions can be checked at three levels:
@@ -72,7 +72,7 @@
example: heiths
required: true
description: The username to check
-- bearerAuth:
+bearerAuth:
# This can also be done with ?access_token=
# But it's simpler in the docs / Try It interface to just show one option
# and using the header method keeps it separate from query params that the
individual API endpoints use
