Skip to content

Commit f33dfde

Browse files
lpabonlpabon
committed
v0.101.1
1 parent 49420be commit f33dfde

File tree

9 files changed

+2565
-2469
lines changed

9 files changed

+2565
-2469
lines changed

‎api.swagger.json‎

Lines changed: 115 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)",
@@ -902,7 +917,7 @@
902917
"type": "string"
903918
},
904919
"state": {
905-
"$ref": "#/components/schemas/apiJobState"
920+
"$ref": "#/components/schemas/JobState"
906921
},
907922
"type": {
908923
"$ref": "#/components/schemas/apiJobType"
@@ -911,20 +926,6 @@
911926
"title": "Job is a generic job object that can encapsulate other\nmessages which follow the job framework of APIs",
912927
"type": "object"
913928
},
914-
"apiJobState": {
915-
"default": "JOB_STATE_PENDING",
916-
"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",
917-
"enum": [
918-
"JOB_STATE_PENDING",
919-
"JOB_STATE_RUNNING",
920-
"JOB_STATE_DONE",
921-
"JOB_STATE_PAUSED",
922-
"JOB_STATE_CANCELLED",
923-
"JOB_STATE_FAILED"
924-
],
925-
"title": "JobState is an enum for state of a node drain operation",
926-
"type": "string"
927-
},
928929
"apiJobSummary": {
929930
"properties": {
930931
"id": {
@@ -948,12 +949,14 @@
948949
"type": "object"
949950
},
950951
"apiJobType": {
951-
"default": "JobTypeNone",
952+
"default": "UNSPECIFIED_TYPE",
953+
"description": "- UNSPECIFIED_TYPE: Unspecified\n - NONE: None\n - DRAIN_ATTACHMENTS: Job for draining volume attachments",
952954
"enum": [
953-
"JobTypeNone",
954-
"JobTypeDrainAttachments"
955+
"UNSPECIFIED_TYPE",
956+
"NONE",
957+
"DRAIN_ATTACHMENTS"
955958
],
956-
"title": "JobType are the supported job types",
959+
"title": "Type are the supported job types",
957960
"type": "string"
958961
},
959962
"apiJobWorkSummary": {
@@ -2734,6 +2737,16 @@
27342737
"title": "Defines a response for an SDK request that spins up a new job\nto perform the request",
27352738
"type": "object"
27362739
},
2740+
"apiSdkNodeCordonAttachmentsRequest": {
2741+
"properties": {
2742+
"node_id": {
2743+
"title": "Node ID on which any further volume attachments will be disabled",
2744+
"type": "string"
2745+
}
2746+
},
2747+
"title": "SdkNodeCordonAttachmentsRequest request for disabling new volume\nattachments from a node",
2748+
"type": "object"
2749+
},
27372750
"apiSdkNodeCordonAttachmentsResponse": {
27382751
"title": "SdkNodeCordonAttachmentsRespinse response for disabling new volume\nattachments from a node",
27392752
"type": "object"
@@ -2808,6 +2821,16 @@
28082821
"title": "Defines a response when inspecting a node",
28092822
"type": "object"
28102823
},
2824+
"apiSdkNodeUncordonAttachmentsRequest": {
2825+
"properties": {
2826+
"node_id": {
2827+
"title": "Node ID on which any further volume attachments will be enabled",
2828+
"type": "string"
2829+
}
2830+
},
2831+
"title": "SdkNodeUncordonAttachmentsRequest request for re-enabling volume\nattachments for a node",
2832+
"type": "object"
2833+
},
28112834
"apiSdkNodeUncordonAttachmentsResponse": {
28122835
"title": "SdkNodeUncordonAttachmentsRespinse response for enabling new volume\nattachments from a node",
28132836
"type": "object"
@@ -3333,6 +3356,22 @@
33333356
"title": "Defines times of day",
33343357
"type": "string"
33353358
},
3359+
"apiSdkUpdateJobRequest": {
3360+
"properties": {
3361+
"id": {
3362+
"title": "ID of the job",
3363+
"type": "string"
3364+
},
3365+
"state": {
3366+
"$ref": "#/components/schemas/JobState"
3367+
},
3368+
"type": {
3369+
"$ref": "#/components/schemas/apiJobType"
3370+
}
3371+
},
3372+
"title": "Defines a request to update an existing job",
3373+
"type": "object"
3374+
},
33363375
"apiSdkUpdateJobResponse": {
33373376
"title": "Defines the response for an update to an existing job",
33383377
"type": "object"
@@ -5161,7 +5200,7 @@
51615200
},
51625201
"info": {
51635202
"title": "OpenStorage SDK",
5164-
"version": "0.101.0"
5203+
"version": "0.101.1"
51655204
},
51665205
"openapi": "3.0.0",
51675206
"paths": {
@@ -6425,18 +6464,19 @@
64256464
},
64266465
"/v1/jobs": {
64276466
"get": {
6428-
"operationId": "EnumerateJobs",
6467+
"operationId": "Enumerate",
64296468
"parameters": [
64306469
{
6431-
"description": "Type if specified will list the jobs of the provided type.",
6470+
"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",
64326471
"in": "query",
64336472
"name": "type",
64346473
"required": false,
64356474
"schema": {
6436-
"default": "JobTypeNone",
6475+
"default": "UNSPECIFIED_TYPE",
64376476
"enum": [
6438-
"JobTypeNone",
6439-
"JobTypeDrainAttachments"
6477+
"UNSPECIFIED_TYPE",
6478+
"NONE",
6479+
"DRAIN_ATTACHMENTS"
64406480
],
64416481
"type": "string"
64426482
}
@@ -6454,15 +6494,15 @@
64546494
"description": ""
64556495
}
64566496
},
6457-
"summary": "EnumerateJobs returns all the jobs currently known to the system",
6497+
"summary": "Enumerate returns all the jobs currently known to the system",
64586498
"tags": [
64596499
"OpenStorageJob"
64606500
]
64616501
}
64626502
},
64636503
"/v1/jobs/{id}": {
64646504
"get": {
6465-
"operationId": "GetJobStatus",
6505+
"operationId": "GetStatus",
64666506
"parameters": [
64676507
{
64686508
"in": "path",
@@ -6473,15 +6513,16 @@
64736513
}
64746514
},
64756515
{
6476-
"description": "Type of the job.",
6516+
"description": "Type of the job.\n\n - UNSPECIFIED_TYPE: Unspecified\n - NONE: None\n - DRAIN_ATTACHMENTS: Job for draining volume attachments",
64776517
"in": "query",
64786518
"name": "type",
64796519
"required": false,
64806520
"schema": {
6481-
"default": "JobTypeNone",
6521+
"default": "UNSPECIFIED_TYPE",
64826522
"enum": [
6483-
"JobTypeNone",
6484-
"JobTypeDrainAttachments"
6523+
"UNSPECIFIED_TYPE",
6524+
"NONE",
6525+
"DRAIN_ATTACHMENTS"
64856526
],
64866527
"type": "string"
64876528
}
@@ -6499,13 +6540,13 @@
64996540
"description": ""
65006541
}
65016542
},
6502-
"summary": "GetJobStatus gets the status of a job",
6543+
"summary": "GetStatus gets the status of a job",
65036544
"tags": [
65046545
"OpenStorageJob"
65056546
]
65066547
},
65076548
"put": {
6508-
"operationId": "UpdateJobState",
6549+
"operationId": "Update",
65096550
"parameters": [
65106551
{
65116552
"in": "path",
@@ -6516,6 +6557,16 @@
65166557
}
65176558
}
65186559
],
6560+
"requestBody": {
6561+
"content": {
6562+
"application/json": {
6563+
"schema": {
6564+
"$ref": "#/components/schemas/apiSdkUpdateJobRequest"
6565+
}
6566+
}
6567+
},
6568+
"required": true
6569+
},
65196570
"responses": {
65206571
"200": {
65216572
"content": {
@@ -6528,7 +6579,7 @@
65286579
"description": ""
65296580
}
65306581
},
6531-
"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",
6582+
"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",
65326583
"tags": [
65336584
"OpenStorageJob"
65346585
]
@@ -6696,6 +6747,16 @@
66966747
}
66976748
}
66986749
],
6750+
"requestBody": {
6751+
"content": {
6752+
"application/json": {
6753+
"schema": {
6754+
"$ref": "#/components/schemas/apiSdkNodeCordonAttachmentsRequest"
6755+
}
6756+
}
6757+
},
6758+
"required": true
6759+
},
66996760
"responses": {
67006761
"200": {
67016762
"content": {
@@ -6727,6 +6788,16 @@
67276788
}
67286789
}
67296790
],
6791+
"requestBody": {
6792+
"content": {
6793+
"application/json": {
6794+
"schema": {
6795+
"$ref": "#/components/schemas/apiSdkNodeDrainAttachmentsRequest"
6796+
}
6797+
}
6798+
},
6799+
"required": true
6800+
},
67306801
"responses": {
67316802
"200": {
67326803
"content": {
@@ -6758,6 +6829,16 @@
67586829
}
67596830
}
67606831
],
6832+
"requestBody": {
6833+
"content": {
6834+
"application/json": {
6835+
"schema": {
6836+
"$ref": "#/components/schemas/apiSdkNodeUncordonAttachmentsRequest"
6837+
}
6838+
}
6839+
},
6840+
"required": true
6841+
},
67616842
"responses": {
67626843
"200": {
67636844
"content": {

0 commit comments

Comments
 (0)