-
Notifications
You must be signed in to change notification settings - Fork 34
/
Copy pathvertice.raml
179 lines (148 loc) · 4.82 KB
/
vertice.raml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
#%RAML 0.8
title: Example
version: 1
baseUri: http://example.com/{version}
documentation:
- title: Welcome
content: |
Welcome to the Example Documentation. The Example API allows you
to do stuff. See also [example.com](https://www.example.com).
```javascript
var raml2html = require('raml2html');
// Using the default templates:
// source can either be a filename, file contents (string) or parsed RAML object
raml2html.parse(source, onSuccess, onError);
// Using your own templates:
// - config should be an object with at least an `template` property
// - config can also include `helpers` and `partials`
// - the config object will be accessible from your handlebars templates
raml2html.parseWithConfig(source, config, onSuccess, onError);
```
- title: Chapter two
content: More content here. Including **bold** text!
securitySchemes:
- oauth_1_0:
description: OAuth 1.0 continues to be supported for all API requests, but OAuth 2.0 is now preferred.
type: OAuth 1.0
settings:
requestTokenUri: https://api.dropbox.com/1/oauth/request_token
authorizationUri: https://www.dropbox.com/1/oauth/authorize
tokenCredentialsUri: https://api.dropbox.com/1/oauth/access_token
traits:
- paged:
queryParameters:
page_size:
description: The number of items per page
type: number
default: 20
page:
description: The page to return
type: number
default: 0
/account:
displayName: ACCOUNTS
description: |
Accounts represents the details of user access information
post:
description: |
Creates a new account.
body:
application/json:
example: |
{
"email": "[email protected]",
"password": "super_secret",
"name": "John Doe"
}
responses:
201:
description: The request has been fulfilled, resulting in the creation of a new Account was created and user is now logged in.
get:
description: |
Get the user account details.
responses:
200:
description: The request has succeeded, the response will contain an entity of required account details.
404:
description: The requested resource could not be found
/assemblies:
displayName: ASSEMBLIES
description: |
Assemblies is a CAMP term which represents a group of application and services and their declaration.
post:
description: |
Creates a new assemblies
body:
application/json:
example: |
{
"name": "calcines",
"org_id": "ORG123",
"assemblies": []
}
responses:
201:
description: The request has been fulfilled, resulting in the creation of a new assemblies.
get:
description: |
Get the assemblies details
responses:
200:
description: The request has succeeded, the response will contain an entity of required assemblies details.
404:
description: The requested resource could not be found
/assembly:
displayName: ASSEMBLY
description: |
Assembly is a CAMP term which represents a VM can be an assembly. We assume that A VM will contain one component only
post:
description: |
Creates a new assembly.
body:
application/json:
example: |
{
"name": "calcines",
"org_id": "ORG123",
"components": []
}
responses:
201:
description: The request has been fulfilled, resulting in the creation of a new assembly.
get:
description: |
Get the assembly details.
responses:
200:
description: The request has succeeded, the response will contain an entity of required assembly details.
404:
description: The requested resource could not be found
/components:
displayName: COMPONENTS
description: |
Components is a CAMP term which represents an application or a service that can be assembled.
post:
description: |
Creates a new components and user is now launched the apps.
body:
application/json:
example: |
{
"name": "NettieMoore",
"tosca_type": "tosca.web.redis",
"inputs": [{
"key" : "domain",
"value" : "megam.co",
}]
}
responses:
201:
description: The request has been fulfilled, resulting in the creation of a new components.
get:
description: |
Get the components details.
responses:
200:
description: The request has succeeded, the response will contain an entity of required components details.
404:
description: The requested resource could not be found