Skip to content

Commit 3d4f831

Browse files
lpabonlpabon
committed
v0.69.32
1 parent f0ae684 commit 3d4f831

File tree

9 files changed

+3047
-2484
lines changed

9 files changed

+3047
-2484
lines changed

‎api.swagger.json‎

Lines changed: 138 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,21 @@
5151
"title": "FilesystemTrimStatus represents the status codes returned from\nOpenStorageFilesystemTrim service APIs()",
5252
"type": "string"
5353
},
54+
"JobState": {
55+
"default": "UNSPECIFIED_STATE",
56+
"description": "- UNSPECIFIED_STATE: Unspecified\n - PENDING: Pending indicates job is still pending and has not started work\n - RUNNING: Running indicates job is actively running\n - DONE: Done indicates job has finished processing\n - PAUSED: Paused indicates job is paused\n - CANCELLED: Cancelled indicates job is cancelled\n - FAILED: Failed indicates job has failed",
57+
"enum": [
58+
"UNSPECIFIED_STATE",
59+
"PENDING",
60+
"RUNNING",
61+
"DONE",
62+
"PAUSED",
63+
"CANCELLED",
64+
"FAILED"
65+
],
66+
"title": "State is an enum for state of a node drain operation",
67+
"type": "string"
68+
},
5469
"LabelSelectorRequirementOperator": {
5570
"default": "In",
5671
"description": "- In: In means the value for 'key' should be in one of the given value(s)\n - NotIn: NotIn means the value for 'key' should NOT be in one of the given value(s)\n - Exists: Exists means the 'key' should just exist regardless of the value\n - DoesNotExist: DoesNotExist means the 'key' should NOT exist\n - Gt: Gt means the 'key' should be greater than the value(s)\n - Lt: Lt means the 'key' should be less than the value(s)",
@@ -373,6 +388,23 @@
373388
},
374389
"type": "object"
375390
},
391+
"apiCloudDriveTransferJob": {
392+
"properties": {
393+
"destination_instance_id": {
394+
"title": "DestinationInstanceID is the ID of the storageless instance that needs to take over the SourceDriveSetID",
395+
"type": "string"
396+
},
397+
"source_driveset_id": {
398+
"title": "SourceDrivesetID is the ID of the current driveset that needs to be transferred",
399+
"type": "string"
400+
},
401+
"status": {
402+
"title": "Status describes a helpful status of this operation",
403+
"type": "string"
404+
}
405+
},
406+
"type": "object"
407+
},
376408
"apiCloudMigrateCancelRequest": {
377409
"properties": {
378410
"task_id": {
@@ -873,6 +905,9 @@
873905
},
874906
"apiJob": {
875907
"properties": {
908+
"clouddrive_transfer": {
909+
"$ref": "#/components/schemas/apiCloudDriveTransferJob"
910+
},
876911
"create_time": {
877912
"format": "date-time",
878913
"title": "CreateTime is the time the job was created",
@@ -891,7 +926,7 @@
891926
"type": "string"
892927
},
893928
"state": {
894-
"$ref": "#/components/schemas/apiJobState"
929+
"$ref": "#/components/schemas/JobState"
895930
},
896931
"type": {
897932
"$ref": "#/components/schemas/apiJobType"
@@ -900,20 +935,6 @@
900935
"title": "Job is a generic job object that can encapsulate other\nmessages which follow the job framework of APIs",
901936
"type": "object"
902937
},
903-
"apiJobState": {
904-
"default": "JOB_STATE_PENDING",
905-
"description": "- JOB_STATE_PENDING: Pending indicates job is still pending and has not started work\n - JOB_STATE_RUNNING: Running indicates job is actively running\n - JOB_STATE_DONE: Done indicates job has finished processing\n - JOB_STATE_PAUSED: Paused indicates job is paused\n - JOB_STATE_CANCELLED: Cancelled indicates job is cancelled\n - JOB_STATE_FAILED: Failed indicates job has failed",
906-
"enum": [
907-
"JOB_STATE_PENDING",
908-
"JOB_STATE_RUNNING",
909-
"JOB_STATE_DONE",
910-
"JOB_STATE_PAUSED",
911-
"JOB_STATE_CANCELLED",
912-
"JOB_STATE_FAILED"
913-
],
914-
"title": "JobState is an enum for state of a node drain operation",
915-
"type": "string"
916-
},
917938
"apiJobSummary": {
918939
"properties": {
919940
"id": {
@@ -937,12 +958,15 @@
937958
"type": "object"
938959
},
939960
"apiJobType": {
940-
"default": "JobTypeNone",
961+
"default": "UNSPECIFIED_TYPE",
962+
"description": "- UNSPECIFIED_TYPE: Unspecified\n - NONE: None\n - DRAIN_ATTACHMENTS: Job for draining volume attachments\n - CLOUD_DRIVE_TRANSFER: Job for transferring cloud drives between nodes",
941963
"enum": [
942-
"JobTypeNone",
943-
"JobTypeDrainAttachments"
964+
"UNSPECIFIED_TYPE",
965+
"NONE",
966+
"DRAIN_ATTACHMENTS",
967+
"CLOUD_DRIVE_TRANSFER"
944968
],
945-
"title": "JobType are the supported job types",
969+
"title": "Type are the supported job types",
946970
"type": "string"
947971
},
948972
"apiJobWorkSummary": {
@@ -2723,6 +2747,16 @@
27232747
"title": "Defines a response for an SDK request that spins up a new job\nto perform the request",
27242748
"type": "object"
27252749
},
2750+
"apiSdkNodeCordonAttachmentsRequest": {
2751+
"properties": {
2752+
"node_id": {
2753+
"title": "Node ID on which any further volume attachments will be disabled",
2754+
"type": "string"
2755+
}
2756+
},
2757+
"title": "SdkNodeCordonAttachmentsRequest request for disabling new volume\nattachments from a node",
2758+
"type": "object"
2759+
},
27262760
"apiSdkNodeCordonAttachmentsResponse": {
27272761
"title": "SdkNodeCordonAttachmentsRespinse response for disabling new volume\nattachments from a node",
27282762
"type": "object"
@@ -2797,6 +2831,16 @@
27972831
"title": "Defines a response when inspecting a node",
27982832
"type": "object"
27992833
},
2834+
"apiSdkNodeUncordonAttachmentsRequest": {
2835+
"properties": {
2836+
"node_id": {
2837+
"title": "Node ID on which any further volume attachments will be enabled",
2838+
"type": "string"
2839+
}
2840+
},
2841+
"title": "SdkNodeUncordonAttachmentsRequest request for re-enabling volume\nattachments for a node",
2842+
"type": "object"
2843+
},
28002844
"apiSdkNodeUncordonAttachmentsResponse": {
28012845
"title": "SdkNodeUncordonAttachmentsRespinse response for enabling new volume\nattachments from a node",
28022846
"type": "object"
@@ -3322,6 +3366,22 @@
33223366
"title": "Defines times of day",
33233367
"type": "string"
33243368
},
3369+
"apiSdkUpdateJobRequest": {
3370+
"properties": {
3371+
"id": {
3372+
"title": "ID of the job",
3373+
"type": "string"
3374+
},
3375+
"state": {
3376+
"$ref": "#/components/schemas/JobState"
3377+
},
3378+
"type": {
3379+
"$ref": "#/components/schemas/apiJobType"
3380+
}
3381+
},
3382+
"title": "Defines a request to update an existing job",
3383+
"type": "object"
3384+
},
33253385
"apiSdkUpdateJobResponse": {
33263386
"title": "Defines the response for an update to an existing job",
33273387
"type": "object"
@@ -5150,7 +5210,7 @@
51505210
},
51515211
"info": {
51525212
"title": "OpenStorage SDK",
5153-
"version": "0.69.29"
5213+
"version": "0.69.32"
51545214
},
51555215
"openapi": "3.0.0",
51565216
"paths": {
@@ -6414,18 +6474,20 @@
64146474
},
64156475
"/v1/jobs": {
64166476
"get": {
6417-
"operationId": "EnumerateJobs",
6477+
"operationId": "Enumerate",
64186478
"parameters": [
64196479
{
6420-
"description": "Type if specified will list the jobs of the provided type.",
6480+
"description": "Type if specified will list the jobs of the provided type.\n\n - UNSPECIFIED_TYPE: Unspecified\n - NONE: None\n - DRAIN_ATTACHMENTS: Job for draining volume attachments\n - CLOUD_DRIVE_TRANSFER: Job for transferring cloud drives between nodes",
64216481
"in": "query",
64226482
"name": "type",
64236483
"required": false,
64246484
"schema": {
6425-
"default": "JobTypeNone",
6485+
"default": "UNSPECIFIED_TYPE",
64266486
"enum": [
6427-
"JobTypeNone",
6428-
"JobTypeDrainAttachments"
6487+
"UNSPECIFIED_TYPE",
6488+
"NONE",
6489+
"DRAIN_ATTACHMENTS",
6490+
"CLOUD_DRIVE_TRANSFER"
64296491
],
64306492
"type": "string"
64316493
}
@@ -6443,15 +6505,15 @@
64436505
"description": ""
64446506
}
64456507
},
6446-
"summary": "EnumerateJobs returns all the jobs currently known to the system",
6508+
"summary": "Enumerate returns all the jobs currently known to the system",
64476509
"tags": [
64486510
"OpenStorageJob"
64496511
]
64506512
}
64516513
},
64526514
"/v1/jobs/{id}": {
64536515
"get": {
6454-
"operationId": "GetJobStatus",
6516+
"operationId": "GetStatus",
64556517
"parameters": [
64566518
{
64576519
"in": "path",
@@ -6462,15 +6524,17 @@
64626524
}
64636525
},
64646526
{
6465-
"description": "Type of the job.",
6527+
"description": "Type of the job.\n\n - UNSPECIFIED_TYPE: Unspecified\n - NONE: None\n - DRAIN_ATTACHMENTS: Job for draining volume attachments\n - CLOUD_DRIVE_TRANSFER: Job for transferring cloud drives between nodes",
64666528
"in": "query",
64676529
"name": "type",
64686530
"required": false,
64696531
"schema": {
6470-
"default": "JobTypeNone",
6532+
"default": "UNSPECIFIED_TYPE",
64716533
"enum": [
6472-
"JobTypeNone",
6473-
"JobTypeDrainAttachments"
6534+
"UNSPECIFIED_TYPE",
6535+
"NONE",
6536+
"DRAIN_ATTACHMENTS",
6537+
"CLOUD_DRIVE_TRANSFER"
64746538
],
64756539
"type": "string"
64766540
}
@@ -6488,13 +6552,13 @@
64886552
"description": ""
64896553
}
64906554
},
6491-
"summary": "GetJobStatus gets the status of a job",
6555+
"summary": "GetStatus gets the status of a job",
64926556
"tags": [
64936557
"OpenStorageJob"
64946558
]
64956559
},
64966560
"put": {
6497-
"operationId": "UpdateJobState",
6561+
"operationId": "Update",
64986562
"parameters": [
64996563
{
65006564
"in": "path",
@@ -6505,6 +6569,16 @@
65056569
}
65066570
}
65076571
],
6572+
"requestBody": {
6573+
"content": {
6574+
"application/json": {
6575+
"schema": {
6576+
"$ref": "#/components/schemas/apiSdkUpdateJobRequest"
6577+
}
6578+
}
6579+
},
6580+
"required": true
6581+
},
65086582
"responses": {
65096583
"200": {
65106584
"content": {
@@ -6517,7 +6591,7 @@
65176591
"description": ""
65186592
}
65196593
},
6520-
"summary": "UpdateJobState updates an existing job\nOnly acceptable values are\nJobState_PAUSED - acceptable only from running state\nJobState_CANCELLED - acceptable only from running/pause state\nJobState_RUNNING - acceptable only from pause state",
6594+
"summary": "Update updates an existing job's state\nOnly acceptable state values are\nJobState_PAUSED - acceptable only from running state\nJobState_CANCELLED - acceptable only from running/pause state\nJobState_RUNNING - acceptable only from pause state",
65216595
"tags": [
65226596
"OpenStorageJob"
65236597
]
@@ -6685,6 +6759,16 @@
66856759
}
66866760
}
66876761
],
6762+
"requestBody": {
6763+
"content": {
6764+
"application/json": {
6765+
"schema": {
6766+
"$ref": "#/components/schemas/apiSdkNodeCordonAttachmentsRequest"
6767+
}
6768+
}
6769+
},
6770+
"required": true
6771+
},
66886772
"responses": {
66896773
"200": {
66906774
"content": {
@@ -6716,6 +6800,16 @@
67166800
}
67176801
}
67186802
],
6803+
"requestBody": {
6804+
"content": {
6805+
"application/json": {
6806+
"schema": {
6807+
"$ref": "#/components/schemas/apiSdkNodeDrainAttachmentsRequest"
6808+
}
6809+
}
6810+
},
6811+
"required": true
6812+
},
67196813
"responses": {
67206814
"200": {
67216815
"content": {
@@ -6747,6 +6841,16 @@
67476841
}
67486842
}
67496843
],
6844+
"requestBody": {
6845+
"content": {
6846+
"application/json": {
6847+
"schema": {
6848+
"$ref": "#/components/schemas/apiSdkNodeUncordonAttachmentsRequest"
6849+
}
6850+
}
6851+
},
6852+
"required": true
6853+
},
67506854
"responses": {
67516855
"200": {
67526856
"content": {

0 commit comments

Comments
 (0)