Skip to content

Commit 27d40ae

Browse files
committed
Minor changes of webappservices (/niapp) swagger doc
1 parent 73c5ecc commit 27d40ae

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

webapp/niapp.yaml

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ paths:
3636
put:
3737
tags:
3838
- metadata
39-
summary: Update existing webapp metadata
40-
description: Update webapp metadata by Id
39+
summary: Update webapp metadata by Id
40+
description: Update existing webapp metadata
4141
operationId: update-webapp
4242
parameters:
4343
- $ref: '#/parameters/WebAppId'
@@ -54,8 +54,8 @@ paths:
5454
delete:
5555
tags:
5656
- metadata
57-
summary: ''
58-
description: Delete webapp by id
57+
summary: Delete webapp by Id
58+
description: Delete existing webapp metadata and content
5959
operationId: delete-webapp
6060
parameters:
6161
- $ref: '#/parameters/WebAppId'
@@ -70,8 +70,8 @@ paths:
7070
get:
7171
tags:
7272
- metadata
73-
summary: Lists the webapps
74-
description: Lists the webapps
73+
summary: List the webapps
74+
description: List the webapps
7575
operationId: list-webapps
7676
parameters:
7777
- in: query
@@ -88,16 +88,16 @@ paths:
8888
- WebVI
8989
- in: query
9090
name: userId
91-
description: Filters the webapps by the user id of the owner
91+
description: Filters the webapps by the user Id of the owner
9292
type: string
9393
- in: query
9494
name: workspace
95-
description: Filters the webapps by workspace id
95+
description: Filters the webapps by workspace Id
9696
type: string
9797
- in: query
9898
name: continuationToken
9999
description: The continuation token can be used to paginate through the webapp list results. Provide a token to continue a previous listing.
100-
type: integer
100+
type: string
101101
- in: query
102102
name: take
103103
description: How many webapps to return in the result
@@ -145,8 +145,8 @@ paths:
145145
get:
146146
tags:
147147
- metadata
148-
summary: List the emails the user has shared webapps with
149-
description: List the emails the user has shared webapps with
148+
summary: List the emails with which the user has shared webapps
149+
description: List the emails with which the user has shared webapps
150150
operationId: list-shared-emails
151151
responses:
152152
200:
@@ -173,7 +173,7 @@ paths:
173173
tags:
174174
- content
175175
summary: Upload content for an existing webapp
176-
description: Upload content an existing webapp
176+
description: Upload content for an existing webapp
177177
operationId: update-content
178178
parameters:
179179
- $ref: '#/parameters/WebAppId'
@@ -197,7 +197,7 @@ paths:
197197
tags:
198198
- content
199199
summary: Get webapp content by path
200-
description: Get webapp content at path. For webapps with multiple files (e.g. WebVIs)
200+
description: Get the webapp content at a path. This applies to webapps with multiple files, such as WebVIs.
201201
operationId: get-content
202202
parameters:
203203
- $ref: '#/parameters/WebAppId'
@@ -223,7 +223,7 @@ paths:
223223
type: string
224224
required: true
225225
name: sourceId
226-
description: The id of the source webapp to get copy content from
226+
description: The Id of the source webapp to get copy content from
227227
responses:
228228
200:
229229
description: Success
@@ -367,7 +367,7 @@ definitions:
367367
properties:
368368
id :
369369
type: string
370-
description: The webapp id
370+
description: The webapp Id
371371
example: "asdsad-17a6-45323-b64b-65325287372d"
372372
type:
373373
type: string
@@ -400,10 +400,12 @@ definitions:
400400
description: List of policy Ids associated with the webapp, which give it access to the user's resources"
401401
created:
402402
type: string
403+
format: date-time
403404
description: The created timestamp (iso8601 format)
404405
example: "2019-12-02T15:31:45.379Z"
405406
updated:
406407
type: string
408+
format: date-time
407409
description: The last updated timestamp (iso8601 format)
408410
example: "2019-12-02T15:31:45.379Z"
409411
properties:

0 commit comments

Comments
 (0)