Skip to content

Commit 8a2a45d

Browse files
gurunath-avigurunath-avi
committed
Updated assets for swagger
Signed-off-by: gurunath-avi <[email protected]>
1 parent 911aef4 commit 8a2a45d

File tree

340 files changed

+312031
-78068
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

340 files changed

+312031
-78068
lines changed

‎swagger/ALBServicesConfig.json‎

Lines changed: 134 additions & 74 deletions
Large diffs are not rendered by default.

‎swagger/ALBServicesConfig.yaml‎

Lines changed: 131 additions & 87 deletions
Large diffs are not rendered by default.

‎swagger/ALBServicesFileDownload.json‎

Lines changed: 67 additions & 20 deletions
Large diffs are not rendered by default.

‎swagger/ALBServicesFileDownload.yaml‎

Lines changed: 67 additions & 33 deletions
Large diffs are not rendered by default.

‎swagger/ALBServicesFileUpload.json‎

Lines changed: 58 additions & 11 deletions
Large diffs are not rendered by default.

‎swagger/ALBServicesFileUpload.yaml‎

Lines changed: 58 additions & 24 deletions
Large diffs are not rendered by default.

‎swagger/ALBServicesJob.json‎

Lines changed: 69 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"version": "31.1.1",
4+
"version": "31.2.1",
55
"title": "Avi ALBServicesJob Object API",
66
"contact": {
77
"name": "Avi Networks Inc.",
88
"url": "https://avinetworks.com/contact-us",
99
"email": "[email protected]"
1010
},
11-
"description": "CLI\n```\n- configure albservicesjob <key>\n- show albservicesjob <key>\n```\n"
11+
"description": "Avi ALBServicesJob object api\n```\n- configure albservicesjob <key>\n- show albservicesjob <key>\n```\n\nAPI permission: PERMISSION_CONTROLLER\n"
1212
},
13+
"tags": [
14+
{
15+
"name": "ALBServicesJob"
16+
}
17+
],
18+
"schemes": [
19+
"https"
20+
],
1321
"securityDefinitions": {
1422
"basicAuth": {
1523
"type": "basic",
@@ -20,6 +28,11 @@
2028
"paths": {
2129
"/albservicesjob": {
2230
"get": {
31+
"tags": [
32+
"ALBServicesJob"
33+
],
34+
"description": "/albservicesjob",
35+
"operationId": "GET /albservicesjob",
2336
"consumes": [
2437
"application/json"
2538
],
@@ -119,6 +132,11 @@
119132
}
120133
},
121134
"post": {
135+
"tags": [
136+
"ALBServicesJob"
137+
],
138+
"description": "/albservicesjob",
139+
"operationId": "POST /albservicesjob",
122140
"consumes": [
123141
"application/json"
124142
],
@@ -184,6 +202,11 @@
184202
},
185203
"/albservicesjob/{uuid}": {
186204
"get": {
205+
"tags": [
206+
"ALBServicesJob"
207+
],
208+
"description": "/albservicesjob/{uuid}",
209+
"operationId": "GET /albservicesjob/{uuid}",
187210
"consumes": [
188211
"application/json"
189212
],
@@ -274,10 +297,18 @@
274297
},
275298
"401": {
276299
"description": "log in failed"
300+
},
301+
"404": {
302+
"description": "object not found"
277303
}
278304
}
279305
},
280306
"put": {
307+
"tags": [
308+
"ALBServicesJob"
309+
],
310+
"description": "/albservicesjob/{uuid}",
311+
"operationId": "PUT /albservicesjob/{uuid}",
281312
"consumes": [
282313
"application/json"
283314
],
@@ -351,10 +382,18 @@
351382
},
352383
"401": {
353384
"description": "log in failed"
385+
},
386+
"404": {
387+
"description": "object not found"
354388
}
355389
}
356390
},
357391
"patch": {
392+
"tags": [
393+
"ALBServicesJob"
394+
],
395+
"description": "/albservicesjob/{uuid}",
396+
"operationId": "PATCH /albservicesjob/{uuid}",
358397
"consumes": [
359398
"application/json"
360399
],
@@ -428,10 +467,18 @@
428467
},
429468
"401": {
430469
"description": "log in failed"
470+
},
471+
"404": {
472+
"description": "object not found"
431473
}
432474
}
433475
},
434476
"delete": {
477+
"tags": [
478+
"ALBServicesJob"
479+
],
480+
"description": "/albservicesjob/{uuid}",
481+
"operationId": "DELETE /albservicesjob/{uuid}",
435482
"consumes": [
436483
"application/json"
437484
],
@@ -495,7 +542,7 @@
495542
}
496543
},
497544
"404": {
498-
"description": "not found"
545+
"description": "object not found"
499546
}
500547
}
501548
}
@@ -515,59 +562,59 @@
515562
"type": "string"
516563
},
517564
"command": {
518-
"description": "The command to be triggered by the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
565+
"description": "The command to be triggered by the albservicesjob. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
519566
"type": "string"
520567
},
521568
"configpb_attributes": {
522-
"description": "Protobuf versioning for config pbs. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.",
569+
"description": "Protobuf versioning for config pbs. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.",
523570
"$ref": "#/definitions/ConfigPbAttributes"
524571
},
525572
"end_time": {
526-
"description": "Time at which the albservicesjob ended. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
573+
"description": "Time at which the albservicesjob ended. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
527574
"$ref": "#/definitions/TimeStamp"
528575
},
529576
"name": {
530-
"description": "The name of the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
577+
"description": "The name of the albservicesjob. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
531578
"type": "string"
532579
},
533580
"params": {
534-
"description": "Job params. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
581+
"description": "Job params. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
535582
"type": "array",
536583
"items": {
537584
"$ref": "#/definitions/ALBServicesJobParam"
538585
}
539586
},
540587
"pulse_job_id": {
541-
"description": "A unique identifier for this job entry on the Pulse Cloud Services. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
588+
"description": "A unique identifier for this job entry on the Pulse Cloud Services. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
542589
"type": "string"
543590
},
544591
"pulse_sync_status": {
545-
"description": "Status of sync to Pulse Cloud Services(result uploads/state updates). Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
592+
"description": "Status of sync to Pulse Cloud Services(result uploads/state updates). Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
546593
"type": "boolean"
547594
},
548595
"result": {
549-
"description": "Job result. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
596+
"description": "Job result. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
550597
"type": "string"
551598
},
552599
"start_time": {
553-
"description": "Time at which the albservicesjob started. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
600+
"description": "Time at which the albservicesjob started. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
554601
"$ref": "#/definitions/TimeStamp"
555602
},
556603
"status": {
557-
"description": "The status of the albservicesjob. Enum options - UNDETERMINED, PENDING, IN_PROGRESS, COMPLETED, FAILED, NOT_ENABLED. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
604+
"description": "The status of the albservicesjob. Enum options - UNDETERMINED, PENDING, IN_PROGRESS, COMPLETED, FAILED, NOT_ENABLED. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
558605
"type": "string",
559606
"default": "PENDING"
560607
},
561608
"status_update_time": {
562-
"description": "Time at which the status of albservicesjob updated. Field introduced in 22.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
609+
"description": "Time at which the status of albservicesjob updated. Field introduced in 22.1.6. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
563610
"$ref": "#/definitions/TimeStamp"
564611
},
565612
"tenant_ref": {
566-
"description": "The unique identifier of the tenant to which this albservicesjob belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
613+
"description": "The unique identifier of the tenant to which this albservicesjob belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
567614
"type": "string"
568615
},
569616
"token": {
570-
"description": "Job token. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
617+
"description": "Job token. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
571618
"type": "string"
572619
},
573620
"url": {
@@ -576,7 +623,7 @@
576623
"type": "string"
577624
},
578625
"uuid": {
579-
"description": "A unique identifier for this albservicesjob entry. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
626+
"description": "A unique identifier for this albservicesjob entry. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
580627
"type": "string"
581628
}
582629
}
@@ -607,11 +654,11 @@
607654
"type": "object",
608655
"properties": {
609656
"key": {
610-
"description": "Parameter name. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
657+
"description": "Parameter name. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
611658
"type": "string"
612659
},
613660
"value": {
614-
"description": "Parameter value. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
661+
"description": "Parameter value. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.",
615662
"type": "string"
616663
}
617664
}
@@ -620,7 +667,7 @@
620667
"type": "object",
621668
"properties": {
622669
"version": {
623-
"description": "Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.",
670+
"description": "Version sequence number that monotonically advances with each configuration update event. Field introduced in 21.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.",
624671
"type": "integer",
625672
"default": 1,
626673
"format": "uint32"
@@ -635,12 +682,12 @@
635682
],
636683
"properties": {
637684
"secs": {
638-
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
685+
"description": " Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.",
639686
"type": "integer",
640687
"format": "int64"
641688
},
642689
"usecs": {
643-
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
690+
"description": " Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.",
644691
"type": "integer",
645692
"format": "int64"
646693
}

0 commit comments

Comments
 (0)