You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by br...@apache.org on 2015/08/13 22:31:35 UTC
allura git commit: [#6797] remove unneeded 'member' type;
rename 'tool' since its used for more than just top-level tool
endpoints
Repository: allura
Updated Branches:
refs/heads/db/6797 f864c018d -> 436829bb9
[#6797] remove unneeded 'member' type; rename 'tool' since its used for more than just top-level tool endpoints
Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/436829bb
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/436829bb
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/436829bb
Branch: refs/heads/db/6797
Commit: 436829bb98879b55b66153953ef80bd9b30136e7
Parents: f864c01
Author: Dave Brondsema <da...@brondsema.net>
Authored: Thu Aug 13 16:30:30 2015 -0400
Committer: Dave Brondsema <da...@brondsema.net>
Committed: Thu Aug 13 16:30:30 2015 -0400
----------------------------------------------------------------------
Allura/docs/api-rest/api.raml | 48 ++++++++++++++--------------
Allura/docs/api-rest/resourceTypes.yaml | 15 +++------
2 files changed, 29 insertions(+), 34 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/allura/blob/436829bb/Allura/docs/api-rest/api.raml
----------------------------------------------------------------------
diff --git a/Allura/docs/api-rest/api.raml b/Allura/docs/api-rest/api.raml
index f501679..9a55249 100755
--- a/Allura/docs/api-rest/api.raml
+++ b/Allura/docs/api-rest/api.raml
@@ -49,7 +49,7 @@ baseUriParameters:
pattern: ([a-zA-Z]+)
type: {
- project: {
+ project: {
schema: !include schemas/project.json,
example: !include examples/project.json
}
@@ -71,11 +71,11 @@ baseUriParameters:
description: |
Represents the **Wiki Tool**.
type: {
- tool: {
+ generic: {
example: !include examples/wiki.json,
schema: !include schemas/wiki.json
- }
}
+ }
displayName: Wiki
uriParameters:
@@ -87,7 +87,7 @@ baseUriParameters:
/{title}:
type: {
- tool: {
+ generic: {
example: !include examples/page.json,
schema: !include schemas/page.json
}
@@ -135,7 +135,7 @@ baseUriParameters:
description: |
Represents the **Ticket Tracker Tool**.
type: {
- tool: {
+ generic: {
example: !include examples/tickets.json,
schema: !include schemas/tickets.json
}
@@ -251,9 +251,9 @@ baseUriParameters:
/{ticketNumber}:
type: {
- tool: {
- example: !include examples/ticket.json,
- schema: !include schemas/ticket.json
+ generic: {
+ example: !include examples/ticket.json,
+ schema: !include schemas/ticket.json
}
}
displayName: Ticket Number
@@ -319,7 +319,7 @@ baseUriParameters:
description: |
Represents the **Discussion Tool**.
type: {
- tool: {
+ generic: {
schema: !include schemas/discussion.json,
example: !include examples/discussion.json
}
@@ -340,7 +340,7 @@ baseUriParameters:
description: |
Represents a forum within a Discussion tool.
type: {
- tool: {
+ generic: {
# FIXME
example: !include examples/page.json,
schema: !include schemas/page.json
@@ -381,11 +381,11 @@ baseUriParameters:
/{blog}:
type: {
- tool: {
+ generic: {
example: !include examples/blog.json,
schema: !include schemas/blog.json
- }
}
+ }
description: |
Represents the **Blog tool**
@@ -431,9 +431,9 @@ baseUriParameters:
/{year}/{month}/{title}:
description: Represents a blog post entry.
type: {
- tool: {
- example: !include examples/blogPost.json,
- schema: !include schemas/blogPost.json
+ generic: {
+ example: !include examples/blogPost.json,
+ schema: !include schemas/blogPost.json
}
}
displayName: Blog Post
@@ -492,11 +492,11 @@ baseUriParameters:
description: |
Represents the External Link tool.
type: {
- tool: {
+ generic: {
example: !include examples/link.json,
schema: !include schemas/link.json
- }
}
+ }
get:
description: |
@@ -573,9 +573,9 @@ baseUriParameters:
type: string
/{id}:
type: {
- tool: {
- example: !include examples/webhook.json,
- schema: !include schemas/webhook.json
+ generic: {
+ example: !include examples/webhook.json,
+ schema: !include schemas/webhook.json
}
}
uriParameters:
@@ -653,7 +653,7 @@ baseUriParameters:
Most often you'll use the /profile suffix to return user data.
type: {
- tool:{
+ generic: {
example: !include examples/user.json,
schema: !include schemas/user.json
}
@@ -662,8 +662,8 @@ baseUriParameters:
description: |
A user profile
type: {
- tool:{
- example: !include examples/userProfile.json,
- schema: !include schemas/userProfile.json
+ generic: {
+ example: !include examples/userProfile.json,
+ schema: !include schemas/userProfile.json
}
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/allura/blob/436829bb/Allura/docs/api-rest/resourceTypes.yaml
----------------------------------------------------------------------
diff --git a/Allura/docs/api-rest/resourceTypes.yaml b/Allura/docs/api-rest/resourceTypes.yaml
index 9a69e5a..76807d3 100755
--- a/Allura/docs/api-rest/resourceTypes.yaml
+++ b/Allura/docs/api-rest/resourceTypes.yaml
@@ -17,15 +17,10 @@
type: base
get:
is: [ pageable, bearerAuth ]
-- member:
- type: base
- get?:
- post?:
- put?:
- patch?:
- delete?:
-- tool:
- type: member
+- 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
get:
is: [ bearerAuth ]
responses:
@@ -81,7 +76,7 @@
get:
is: [permissionTestable, bearerAuth]
- project:
- type: member
+ type: base
get:
responses:
200: