This repository is currently being migrated. It's locked while the migration is in progress.
-
Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy pathapi-swagger-v2.yaml
More file actions
2552 lines (2192 loc) · 92.2 KB
/
api-swagger-v2.yaml
File metadata and controls
2552 lines (2192 loc) · 92.2 KB
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: "3.0.2"
info:
title: "StorageOS API"
version: "2.0.0"
contact:
name: StorageOS
url: https://storageos.com
email: [email protected]
externalDocs:
url: https://docs.storageos.com/
description: "The latest StorageOS user documentation"
servers:
- url: /v2
components:
securitySchemes:
# The StorageOS API uses JWT (JSON web token) based authentication.
jwt:
type: http
scheme: bearer
bearerFormat: "JWT"
description: StorageOS uses JSON web tokens for authentication.
schemas:
OpenAPISpec:
type: string
readOnly: true
description: >
Serves this openapi specification file.
# This is the standard HTTP error format used for all API errors.
Error:
type: object
required:
- error
properties:
error:
type: string
example:
error: A short description of the error
# ------------------------------------------------------------------------------
# generic types used across multiple endpoints
# ------------------------------------------------------------------------------
Version:
type: string
maxLength: 30
description: >
An opaque representation of an entity version at the time it was
obtained from the API.
All operations that mutate the entity must include this version
field in the request unchanged.
The format of this type is undefined and may change but the
defined properties will not change.
example: NDI0MjQyNDI0MjQyNDI0MjQy
IgnoreVersion:
type: boolean
default: false
description: >
Ignoring the entity version constraints.
If set to true this value indicates that the user wants to
ignore entity version constraints, thereby "forcing" the
operation.
example: true
ExpiresAt:
type: string
format: date-time
readOnly: true
description: >
The time after which a licence will no longer be valid
This timestamp is set when the licence is created.
String format is RFC3339.
example: "2019-03-10T13:42:42Z"
CreatedAt:
type: string
format: date-time
readOnly: true
description: >
The time the entity was created.
This timestamp is set by the node that created the entity, and
may not be correct if the node's local clock was skewed.
This value is for the user's informative purposes only, and
correctness is not required.
String format is RFC3339.
example: "2019-03-10T13:42:42Z"
UpdatedAt:
type: string
format: date-time
readOnly: true
description: >
The time the entity was last updated.
This timestamp is set by the node that last updated the entity,
and may not be correct if the node's local clock was skewed.
This value is for the user's informative purposes only, and
correctness is not required.
String format is RFC3339.
example: "2019-03-29T23:13:13Z"
FsType:
type: string
enum:
- "ext2"
- "ext3"
- "ext4"
- "xfs"
- "btrfs"
- "block"
description: >
The file system type of a volume. "block" is a raw block device (no filesystem).
example: "ext4"
NodeHealth:
type: string
readOnly: true
enum:
- "online"
- "offline"
- "unknown"
description: >
The operational health of a node entity
example: "online"
MasterHealth:
type: string
readOnly: true
enum:
- "online"
- "offline"
- "unknown"
description: >
The operational health of a volume master deployment
example:
"online"
ReplicaHealth:
type: string
readOnly: true
enum:
- "recovering"
- "provisioning"
- "provisioned"
- "syncing"
- "ready"
- "deleted"
- "failed"
- "unknown"
description: >
The operational health of a volume replica deployment
example: "ready"
SyncProgress:
type: object
readOnly: true
properties:
bytesRemaining:
type: uint64
description: >
Number of bytes left remaining to complete the sync.
example: 500000
throughputBytes:
type: uint64
description: >
The average throughput of the sync given as bytes per
second.
example: 100000
estimatedSecondsRemaining:
type: uint64
description: >
The estimated time left for the sync to complete, given
in seconds. When this field has a value of 0 either the
sync is complete or no duration estimate could be made.
The values reported for bytesRemaining and
throughputBytes provide the client with the information
needed to choose what to display.
example: 5
description: >
The progress report for an ongoing sync.
CapacityStats:
type: object
properties:
total:
type: uint64
default: 0
description: >
Total bytes in the filesystem
example: 42
free:
type: uint64
default: 0
description: >
Free bytes in the filesystem available to root user
example: 42
available:
type: uint64
default: 0
description: >
Byte value available to an unprivileged user
example: 42
Labels:
type: object
description: >
A set of arbitrary key value labels to apply to the entity.
externalDocs:
url: https://docs.storageos.com/v2/openapi-help/labels
additionalProperties:
type: string
example:
env: prod
rack: db-1
LogLevel:
type: string
enum:
- "debug"
- "info"
- "warn"
- "error"
default: "info"
description: >
This setting determines the log level for nodes across
the cluster to use when recording entries in the log.
All entries below the specified log level are discarded,
where "error" is the highest log level and "debug" is
the lowest.
This setting is only checked by nodes on startup.
Changing this setting will not affect the behaviour of
nodes that are already operational.
example: "debug"
LogFormat:
type: string
enum:
- "default"
- "json"
default: "default"
description: >
This setting determines the format nodes in the cluster
will use for log entries.
This setting is only checked by nodes on startup.
Changing this setting will not affect the behaviour of
nodes that are already operational.
example: "json"
# ------------------------------------------------------------------------------
# UUIDs
# ------------------------------------------------------------------------------
ClusterID:
readOnly: true
type: string
description: >
A unique identifier for a cluster.
The format of this type is undefined and may change but the
defined properties will not change.
example: c5666b58-b805-4215-ab4a-cb094948ccc6
NodeID:
readOnly: true
type: string
description: >
A unique identifier for a node.
The format of this type is undefined and may change but the
defined properties will not change.
example: c5666b58-b805-4215-ab4a-cb094948ccc6
VolumeID:
type: string
description: >
A unique identifier for a volume.
The format of this type is undefined and may change but the
defined properties will not change.
example: c5666b58-b805-4215-ab4a-cb094948ccc6
DeploymentID:
type: string
description: >
A unique identifier for a volume deployment.
The format of this type is undefined and may change but the
defined properties will not change.
example: c5666b58-b805-4215-ab4a-cb094948ccc6
NamespaceID:
type: string
description: >
A unique identifier for a namespace.
The format of this type is undefined and may change but the
defined properties will not change..
example: c5666b58-b805-4215-ab4a-cb094948ccc6
UserID:
type: string
description: >
A unique identifier for a user.
The format of this type is undefined and may change but the
defined properties will not change..
example: c5666b58-b805-4215-ab4a-cb094948ccc6
PolicyGroupID:
type: string
description: >
A unique identifier for a policy group.
The format of this type is undefined and may change but the
defined properties will not change..
example: c5666b58-b805-4215-ab4a-cb094948ccc6
# ------------------------------------------------------------------------------
# entity objects (e.g user)
#
# Mutating an entity will have a slightly different data model and are
# defined inline for each endpoint.
# ------------------------------------------------------------------------------
Cluster:
type: object
properties:
id:
$ref: "#/components/schemas/ClusterID"
licence:
$ref: "#/components/schemas/Licence"
disableTelemetry:
type: boolean
default: false
description: Disables collection of telemetry data across the cluster.
example: false
disableCrashReporting:
type: boolean
default: false
description: >
Disables collection of reports for any fatal crashes across the
cluster.
example: false
disableVersionCheck:
type: boolean
default: false
description: >
Disables the mechanism responsible for checking if there is an
updated version of StorageOS available for installation.
example: false
logLevel:
$ref: "#/components/schemas/LogLevel"
logFormat:
$ref: "#/components/schemas/LogFormat"
createdAt:
$ref: "#/components/schemas/CreatedAt"
updatedAt:
$ref: "#/components/schemas/UpdatedAt"
version:
$ref: "#/components/schemas/Version"
User:
type: object
properties:
id:
$ref: "#/components/schemas/UserID"
username:
type: string
example: admin
isAdmin:
type: boolean
default: false
description: >
If true, this user is an administrator of the cluster.
Administrators bypass the usual authentication checks
and are granted access to all resources. Some actions
(such as adding a new user) can only be performed by an
administrator.
example: true
groups:
type: array
items:
$ref: "#/components/schemas/PolicyGroupID"
default: []
nullable: true
description: >
Defines a set of policy group IDs this user is a member
of.
Policy groups can be used to logically group users and
apply authorisation policies to all members.
example:
- "24d5db6f-9738-4f17-a257-b9dd41a35309"
- "4223b453-4d47-49d5-960f-23fc7a8153ba"
createdAt:
$ref: "#/components/schemas/CreatedAt"
updatedAt:
$ref: "#/components/schemas/UpdatedAt"
version:
$ref: "#/components/schemas/Version"
Volume:
type: object
properties:
id:
$ref: "#/components/schemas/VolumeID"
name:
type: string
example: "app-data"
description:
type: string
example: "This volume contains the data for my app"
attachedOn:
readOnly: true
allOf:
- $ref: "#/components/schemas/NodeID"
namespaceID:
readOnly: true
allOf:
- $ref: "#/components/schemas/NamespaceID"
labels:
$ref: "#/components/schemas/Labels"
fsType:
$ref: "#/components/schemas/FsType"
master:
readOnly: true
allOf:
- $ref: "#/components/schemas/MasterDeploymentInfo"
replicas:
type: array
nullable: true
readOnly: true
default: []
items:
$ref: "#/components/schemas/ReplicaDeploymentInfo"
sizeBytes:
type: uint64
description: >
A volume's size in bytes
minimum: 0
example: 5000
createdAt:
$ref: "#/components/schemas/CreatedAt"
updatedAt:
$ref: "#/components/schemas/UpdatedAt"
version:
$ref: "#/components/schemas/Version"
DeploymentInfo:
type: object
properties:
id:
$ref: "#/components/schemas/DeploymentID"
nodeID:
$ref: "#/components/schemas/NodeID"
promotable:
type: boolean
description: >
Indicates if the volume deployment is eligible for promotion
MasterDeploymentInfo:
allOf:
- $ref: '#/components/schemas/DeploymentInfo'
- type: object
properties:
health:
$ref: "#/components/schemas/MasterHealth"
ReplicaDeploymentInfo:
allOf:
- $ref: '#/components/schemas/DeploymentInfo'
- type: object
properties:
health:
$ref: "#/components/schemas/ReplicaHealth"
syncProgress:
$ref: "#/components/schemas/SyncProgress"
Node:
type: object
properties:
id:
$ref: "#/components/schemas/NodeID"
name:
type: string
readOnly: true
description: >
The hostname of the node.
This value is set by the node each time it joins the
StorageOS cluster.
example: db1.lcy.storageos.network
health:
$ref: "#/components/schemas/NodeHealth"
capacity:
$ref: "#/components/schemas/CapacityStats"
ioEndpoint:
type: string
readOnly: true
description: >
Endpoint at which we operate our dataplane's dfs
service. (used for IO operations)
This value is set on startup by the corresponding
environment variable (IO_ADVERTISE_ADDRESS)
example:
- "192.0.2.1:5703"
supervisorEndpoint:
type: string
readOnly: true
description: >
Endpoint at which we operate our dataplane's supervisor
service (used for sync).
This value is set on startup by the corresponding
environment variable (SUPERVISOR_ADVERTISE_ADDRESS)
example:
- "192.0.2.1:5704"
gossipEndpoint:
type: string
readOnly: true
description: >
Endpoint at which we operate our health checking service.
This value is set on startup by the corresponding
environment variable (GOSSIP_ADVERTISE_ADDRESS)
example:
- "192.0.2.1:5711"
clusteringEndpoint:
type: string
readOnly: true
description: >
Endpoint at which we operate our clustering GRPC API.
This value is set on startup by the corresponding
environment variable (INTERNAL_API_ADVERTISE_ADDRESS)
example:
- "192.0.2.1:5710"
labels:
$ref: "#/components/schemas/Labels"
createdAt:
$ref: "#/components/schemas/CreatedAt"
updatedAt:
$ref: "#/components/schemas/UpdatedAt"
version:
$ref: "#/components/schemas/Version"
Namespace:
type: object
properties:
id:
$ref: "#/components/schemas/NamespaceID"
name:
type: string
readOnly: true
example: "dev"
labels:
$ref: "#/components/schemas/Labels"
createdAt:
$ref: "#/components/schemas/CreatedAt"
updatedAt:
$ref: "#/components/schemas/UpdatedAt"
version:
$ref: "#/components/schemas/Version"
PolicyGroup:
type: object
properties:
id:
$ref: "#/components/schemas/PolicyGroupID"
name:
type: string
example: "dev-users"
users:
type: array
readOnly: true
items:
type: object
properties:
id:
$ref: "#/components/schemas/UserID"
username:
type: string
example: "admin"
description: The list of user IDs which this policy group governs.
example:
- id: "82f297ae-8381-4c09-b9a1-8401c83c418d"
username: "user_a"
- id: "f4bb11d6-594a-4f21-9d1c-d49711a0453e"
username: "user_b"
- id: "30d3a4dc-971b-4f3e-9b89-5da6fea383ce"
username: "user_c"
specs:
type: array
items:
type: object
properties:
namespaceID:
$ref: "#/components/schemas/NamespaceID"
resourceType:
type: string
enum:
- "*"
- "volume"
- "policy"
description: >
The resource type this policy grants access to.
example: "volume"
readOnly:
type: boolean
default: false
description: >
If true, disallows requests that attempt to mutate the
resource.
example: false
description: A set of authorisation policies to apply to the policy group.
default: []
nullable: true
example:
- namespaceID: "251f065a-d89b-4426-a752-5fdd144d00e8"
resourceType: "*"
readOnly: false
- namespaceID: "5f009d1f-6618-43c2-9ae4-e699461dda8e"
resourceType: "volume"
readOnly: true
createdAt:
$ref: "#/components/schemas/CreatedAt"
updatedAt:
$ref: "#/components/schemas/UpdatedAt"
version:
$ref: "#/components/schemas/Version"
Licence:
type: object
properties:
clusterID:
$ref: "#/components/schemas/ClusterID"
expiresAt:
$ref: "#/components/schemas/ExpiresAt"
clusterCapacityBytes:
type: uint64
description: >
The allowed provisioning capacity in bytes
This value if for the cluster, if provisioning a volume
brings the cluster's total provisioned capacity above
it the request will fail
minimum: 0
example: 1000000
kind:
type: string
description: >
Denotes which category the licence belongs to
example: "unregistered"
customerName:
type: string
description: >
A user friendly reference to the customer
example: "Desmond"
description: >
A representation of a cluster's licence properties
AcceptedMessage:
type: object
properties:
msg:
type: string
example:
msg: "asynchronous request accepted with timeout: 10s"
UserList:
type: array
items:
$ref: "#/components/schemas/User"
NamespaceList:
type: array
items:
$ref: "#/components/schemas/Namespace"
NodeList:
type: array
items:
$ref: "#/components/schemas/Node"
PolicyGroupList:
type: array
items:
$ref: "#/components/schemas/PolicyGroup"
VolumeList:
type: array
items:
$ref: "#/components/schemas/Volume"
parameters:
ObjectVersion:
name: version
in: query
description: >
This value is used to perform a conditional delete of the
entity.
If the entity has been modified since the version token was
obtained, the request will fail with a HTTP 409 Conflict.
required: true
schema:
$ref: "#/components/schemas/Version"
IgnoreVersion:
name: ignore-version
in: query
description: >
If set to true this value indicates that the user wants to
ignore entity version constraints, thereby "forcing" the
operation.
required: false
schema:
$ref: "#/components/schemas/IgnoreVersion"
AsyncHeader:
name: async-max
in: header
schema:
type: string
description: >
Optional header which will make the api request asynchronous. The
operation will not be cancelled even if the client disconnect.
The value of this header defines the timeout duration for the request,
it must be set to a valid duration string.
A duration string is a possibly signed sequence of decimal numbers, each with
optional fraction and a unit suffix, such as "300ms", or "2h45m". Valid time
units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
We reject negative or nil duration values.
example: async-max:20s
AsyncParam:
name: async-max
in: query
schema:
type: string
description: >
Optional parameter which will make the api request asynchronous. The
operation will not be cancelled even if the client disconnect.
The URL parameter value overrides the "async-max" header value, if any.
The value of this header defines the timeout duration for the request,
it must be set to a valid duration string.
A duration string is a possibly signed sequence of decimal numbers, each with
optional fraction and a unit suffix, such as "300ms", or "2h45m". Valid time
units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
We reject negative or nil duration values.
responses:
BadRequest:
description: The request does not conform to the API specification.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: a short description of the validation failure
ServerError:
description: >
The request caused an internal server error and should be
retried.
Check the health of the node/cluster and if the error persists,
contact support.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
StoreError:
description: >
The server is currently unable to handle the request due to
a temporary store failure.
Check the health of the node/cluster and if the error persists,
contact support.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
LicenceRestricted:
description: >
The requested operation failed because your storageOS licence
does not allow it, either create an account for a free licence
or buy a professional licence.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: insufficient allowed capacity (bytes) (used 53687091200, allowed 53687091200, requested 5000000)
Unauthorised:
description: >
The requested endpoint requires authentication - you must log in
first.
If attempting to log in, your credentials were not recognised.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: authentication required
Forbidden:
description: >
The authenticated user does not have permission to perform the
requested action.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: unauthorised
NotFound:
description: >
A referenced resource does not exist.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: not found
InsufficientStorage:
description: >
Available storage is not enough to handle the request.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: insufficient storage capacity available
StaleWrite:
description: >
The entity to be wrote has been concurrently updated by another
request - the submitted entity data has been replaced.
The caller should fetch the entity again, check the actions are
still required and resubmit the request with the new entity
version field.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: attempting to write stale object
InvalidStateTransition:
description: >
An action was requested that cannot be performed on the entity
in it's current state.
As an example, this error might be returned when trying to
delete a currently mounted volume.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: invalid state for operation (currently "deleted")
AlreadyExists:
description: >
The entity to be wrote uses an identifier that already exists.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: already exists
InUse:
description: >
A referenced entity is currently in use.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error: in use
Accepted:
description: >
An aynchronous request has been accepted
content:
application/json:
schema:
$ref: "#/components/schemas/AcceptedMessage"
paths:
/auth/login:
post:
summary: Authenticate a user
operationId: authenticateUser
description: Generate a new JWT token for a user.
requestBody:
description: The credentials to use for authentication.
required: true
content:
application/json:
schema:
type: object
title: AuthUserData
required:
- username
- password
properties:
username:
type: string
password:
type: string
format: password
example:
username: admin
password: supersecret
responses:
"200":
description: Successfully authenticated the returned user.
headers:
Authorization:
description: >
The JWT token - this header should be sent to
the server to perform an authenticated request.
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"400":
$ref: "#/components/responses/BadRequest"
"401":
# The user is not recognised, or the password is incorrect
$ref: "#/components/responses/Unauthorised"
"500":
$ref: "#/components/responses/ServerError"
"503":
$ref: "#/components/responses/StoreError"
/auth/refresh:
post:
summary: Refresh the JWT
operationId: refreshJwt
description: Obtain a fresh token with an updated expiry deadline.
security:
- jwt: []
responses:
"200":
description: Refresh was successful
headers:
Authorization:
description: The new JWT token.
schema:
type: string
"401":
# The user has been removed from the system since acquiring
# the token
$ref: "#/components/responses/Unauthorised"
"500":
$ref: "#/components/responses/ServerError"
"503":
$ref: "#/components/responses/StoreError"
/users:
post:
summary: Create a new user
operationId: createUser