Skip to content

Commit 56e739a

Browse files
dseevrdseevr
committed
Fixed netmaster return codes, updated copy, added missing descriptions
Signed-off-by: Bill Robinson <[email protected]>
1 parent 63567ce commit 56e739a

11 files changed

+444
-238
lines changed

‎spec/auth_proxy.raml

+3-1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ securedBy: custom_scheme
4242

4343
/health:
4444
get:
45+
description: Returns the health status of Contiv API server and its netmaster
4546
securedBy: [ null ]
4647
responses:
4748
200:
@@ -66,12 +67,13 @@ securedBy: custom_scheme
6667

6768
/version:
6869
get:
70+
description: Returns the Contiv API server version
6971
securedBy: [ null ]
7072
responses:
7173
200:
7274
body:
7375
application/json: |
74-
{ "version": "1.0.0-beta" }
76+
{ "version": "1.0.0" }
7577
7678
/authorizations:
7779
type: {collection: {provider: auth_proxy}}

‎spec/auth_proxy/libraries/auth_proxy.raml

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ types:
1818
required: false
1919
description: omitted in case netmaster is unhealthy
2020
example: |
21-
{"netmaster":{"status":"healthy","version":"pv1.0.0-alpha-01-27-2017.23-16-47.UTC"},"status":"healthy","version":"1.0.0-alpha"}
21+
{"netmaster":{"status":"healthy","version":"1.0.0"},"status":"healthy","version":"1.0.0"}
2222
2323
ldap_configuration:
2424
properties:
@@ -95,7 +95,7 @@ types:
9595
properties:
9696
username:
9797
type: string
98-
description: user name. If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)
98+
description: "username. If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)"
9999
password: string
100100
example:
101101
username: johndoe

‎spec/auth_proxy/schemas/collection-item.raml

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 ResourceType
22
description: Entity representing <<resourcePathName|!singularize>>
33
get:
4-
description: returns <<resourcePathName|!singularize>>.
4+
description: Returns a <<resourcePathName|!singularize>>.
55
responses:
66
200:
77
body:
@@ -12,11 +12,25 @@ get:
1212
application/json: |
1313
{"message": "<<resourcePathName|!singularize>> not found" }
1414
delete:
15-
description: deletes <<resourcePathName|!singularize>>.
15+
description: Deletes a <<resourcePathName|!singularize>>.
1616
responses:
1717
204:
1818
put?:
19-
description: updates/creates <<resourcePathName|!singularize>>
19+
description: Updates a <<resourcePathName|!singularize>>
20+
body:
21+
application/json:
22+
type: <<provider>>.upd_<<resourcePathName|!singularize>>
23+
responses:
24+
200:
25+
body:
26+
application/json:
27+
type: <<provider>>.<<resourcePathName|!singularize>>
28+
404:
29+
body:
30+
application/json: |
31+
{"message": "<<resourcePathName|!singularize>> not found" }
32+
patch?:
33+
description: Updates part of a <<resourcePathName|!singularize>>
2034
body:
2135
application/json:
2236
type: <<provider>>.upd_<<resourcePathName|!singularize>>
@@ -29,4 +43,3 @@ put?:
2943
body:
3044
application/json: |
3145
{"message": "<<resourcePathName|!singularize>> not found" }
32-

‎spec/auth_proxy/schemas/collection.raml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
#%RAML 1.0 ResourceType
22
description: A collection of <<resourcePathName>>
33
get:
4-
description: returns a list of <<resourcePathName|!singularize>>.
4+
description: Returns a list of <<resourcePathName|!pluralize>>.
55
responses:
66
200:
77
body:
88
application/json:
9-
type: <<provider>>.<<resourcePathName>>
9+
type: <<provider>>.<<resourcePathName|!pluralize>>
1010
post:
11-
description: Add a new <<resourcePathName|!singularize>>.
11+
description: Create a new <<resourcePathName|!singularize>>.
1212
body:
1313
application/json:
1414
type: <<provider>>.<<resourcePathName|!singularize>>

‎spec/auth_proxy/schemas/non-upd-collection-item.raml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 ResourceType
22
description: Entity representing <<resourcePathName|!singularize>>
33
get:
4-
description: returns <<resourcePathName|!singularize>>.
4+
description: Returns a <<resourcePathName|!singularize>>.
55
responses:
66
200:
77
body:
@@ -12,7 +12,7 @@ get:
1212
application/json: |
1313
{"message": "<<resourcePathName|!singularize>> not found" }
1414
delete:
15-
description: deletes <<resourcePathName|!singularize>>.
15+
description: Deletes a <<resourcePathName|!singularize>>.
1616
responses:
1717
204:
1818

‎spec/auth_proxy/schemas/ro-collection-item.raml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 ResourceType
22
description: Entity representing <<resourcePathName|!singularize>>
33
get:
4-
description: returns <<resourcePathName|!singularize>>.
4+
description: Returns a <<resourcePathName|!singularize>>.
55
responses:
66
200:
77
body:

‎spec/docs/contiv.html

+403-213
Large diffs are not rendered by default.

‎spec/netmaster/schemas/collection-item.raml

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 ResourceType
22
description: Entity representing <<resourcePathName|!singularize>>
33
get:
4-
description: returns <<resourcePathName|!singularize>>.
4+
description: Returns a <<resourcePathName|!singularize>>.
55
responses:
66
200:
77
body:
@@ -12,19 +12,20 @@ get:
1212
application/json: |
1313
{"message": "<<resourcePathName|!singularize>> not found" }
1414
post:
15-
description: Add a new <<resourcePathName|!singularize>>.
15+
description: Creates a new <<resourcePathName|!singularize>>.
1616
body:
1717
application/json:
1818
type: <<provider>>.<<resourcePathName|!singularize>>
1919
responses:
20-
201:
20+
200:
2121
404:
2222
delete:
23-
description: deletes <<resourcePathName|!singularize>>.
23+
description: Deletes a <<resourcePathName|!singularize>>.
2424
responses:
25-
204:
25+
200:
26+
404:
2627
put?:
27-
description: updates/creates <<resourcePathName|!singularize>>
28+
description: Updates a <<resourcePathName|!singularize>>
2829
body:
2930
application/json:
3031
type: <<provider>>.upd_<<resourcePathName|!singularize>>

‎spec/netmaster/schemas/collection.raml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#%RAML 1.0 ResourceType
22
description: A collection of <<resourcePathName>>
33
get:
4-
description: returns a list of <<resourcePathName|!singularize>>.
4+
description: Returns a list of <<resourcePathName|!pluralize>>.
55
responses:
66
200:
77
body:
88
application/json:
9-
type: <<provider>>.<<resourcePathName>>
9+
type: <<provider>>.<<resourcePathName|!pluralize>>

‎spec/netmaster/schemas/non-upd-collection-item.raml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 ResourceType
22
description: Entity representing <<resourcePathName|!singularize>>
33
get:
4-
description: returns <<resourcePathName|!singularize>>.
4+
description: Returns a <<resourcePathName|!singularize>>.
55
responses:
66
200:
77
body:
@@ -12,7 +12,7 @@ get:
1212
application/json: |
1313
{"message": "<<resourcePathName|!singularize>> not found" }
1414
delete:
15-
description: deletes <<resourcePathName|!singularize>>.
15+
description: Deletes a <<resourcePathName|!singularize>>.
1616
responses:
17-
204:
17+
200:
1818

‎spec/netmaster/schemas/ro-collection-item.raml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 ResourceType
22
description: Entity representing <<resourcePathName|!singularize>>
33
get:
4-
description: returns <<resourcePathName|!singularize>>.
4+
description: Returns a <<resourcePathName|!singularize>>.
55
responses:
66
200:
77
body:

0 commit comments

Comments
 (0)