Skip to content

Commit e1ee15f

Browse files
author
Dimitri van Hees
committed
Added examples
1 parent fa2e3fa commit e1ee15f

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

spec.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -399,12 +399,15 @@ definitions:
399399
name:
400400
type: string
401401
description: Name of the resource (file or folder).
402+
example: spec.yaml
402403
description:
403404
type: string
404405
description: Optional description of the resource (file or folder).
406+
example: This is the Open API Specification file (in YAML format) of the Open Cloud Mesh API.
405407
providerId:
406408
type: string
407409
description: Identifier to identify the resource at the provider side. This is unique per provider.
410+
example: 7c084226-d9a1-11e6-bf26-cec0c932ce01
408411
owner:
409412
description: |
410413
Provider specific identifier of the user that wants to share the resource. Please note that the
@@ -431,6 +434,9 @@ definitions:
431434
description: |
432435
JSON object with protocol specific options, e.g. `uri`, `access_token`, `password`, `permissions` etc. At the moment
433436
only `webdav` options are supported, but other (custom) protocol options might be added in the future.
437+
example:
438+
username: dimitri
439+
permissions: 31
434440
Share:
435441
type: object
436442
required: [id, createdAt, _links]
@@ -440,11 +446,12 @@ definitions:
440446
id:
441447
type: string
442448
description: Unique ID to identify the share at the consumer side.
449+
example: 3819
443450
createdAt:
444451
type: string
445452
format: datetime
446453
description: Datetime when the share was created at the consumer side (ISO 8601).
447-
example: 2016-12-05T15:06:58Z
454+
example: "2016-12-05T15:06:58Z"
448455
_links:
449456
type: object
450457
required: [self]
@@ -481,11 +488,12 @@ definitions:
481488
id:
482489
type: string
483490
description: Unique ID to identify the notification at the receiving side.
491+
example: 9303
484492
createdAt:
485493
type: string
486494
format: datetime
487495
description: Datetime when the notification was created at the receiving side (ISO 8601).
488-
example: 2016-12-05T15:06:58Z
496+
example: "2016-12-05T15:06:58Z"
489497
_links:
490498
type: object
491499
required: [self]

0 commit comments

Comments
 (0)