4 "description": "K8s Plugin v1 API for ONAP Honolulu release",
6 "title": "K8s Plugin v1 API",
8 "email": "ritu.sood@intel.com"
11 "host": "multicloud-k8s:9015",
16 "description": "RB Definition management"
20 "description": "RB Definition profile management"
24 "description": "RB Instance management"
36 "summary": "Add a new RB Definition",
38 "operationId": "addRbDefinition",
49 "description": "RB Definition object to create",
52 "$ref": "#/definitions/RbDefinition"
58 "description": "successful operation",
62 "$ref": "#/definitions/RbDefinition"
67 "description": "Invalid input"
75 "summary": "Get all RB Definitions",
76 "description": "Multiple RB Definitions",
77 "operationId": "getRbDefinitions",
83 "description": "successful operation",
87 "$ref": "#/definitions/RbDefinition"
92 "description": "Invalid status value"
97 "/rb/definition/{rbName}": {
102 "summary": "Get all RB Definitions of specified name",
103 "description": "Multiple RB Definitions",
104 "operationId": "getRbDefinitionsByName",
112 "description": "Name of the RB Definition to return",
119 "description": "successful operation",
123 "$ref": "#/definitions/RbDefinition"
128 "description": "Invalid status value"
136 "summary": "Deletes RB Definitions of specified RB Name",
138 "operationId": "deleteRbDefinitionsByRbName",
146 "description": "Name of the RB Definition to return",
153 "description": "Invalid identifiers supplied"
156 "description": "RB Definition not found"
161 "/rb/definition/{rbName}/{rbVersion}": {
166 "summary": "Get RB Definition by Name and Version",
167 "description": "Returns a single RB Definition object",
168 "operationId": "getRbDefinitionByRbName",
176 "description": "Name of the RB Definition to return",
183 "description": "Version of the RB Definition to return",
190 "description": "successful operation",
192 "$ref": "#/definitions/RbDefinition"
196 "description": "Invalid identifiers supplied"
199 "description": "RB Definition not found"
207 "summary": "Deletes RB Definition",
209 "operationId": "deleteRbDefinitionByRbNameAndRbVersion",
217 "description": "Name of the RB Definition to return",
224 "description": "Version of the RB Definition to return",
231 "description": "Invalid identifiers supplied"
234 "description": "RB Definition not found"
239 "/rb/definition/{rbName}/{rbVersion}/content": {
244 "summary": "Uploads Helm package associated with RB Definition",
246 "operationId": "uploadRbDefnitionContent",
257 "description": "Name of the RB Definition to return",
264 "description": "Version of the RB Definition to return",
271 "description": "successful operation",
273 "$ref": "#/definitions/ApiResponse"
279 "/rb/definition/{rbName}/{rbVersion}/profile": {
284 "summary": "Add a new profile for RB Definition",
286 "operationId": "addProfileForDefinition",
297 "description": "Name of the RB Definition to return",
304 "description": "Version of the RB Definition to return",
311 "description": "RB Profile object to create",
314 "$ref": "#/definitions/RbProfile"
320 "description": "successful operation",
324 "$ref": "#/definitions/RbProfile"
329 "description": "Invalid input"
337 "summary": "Get all RB Profiles for RB Definition",
338 "description": "Multiple RB Definitions",
339 "operationId": "getProfilesforRbDefinitions",
347 "description": "Name of the RB Definition to return",
354 "description": "Version of the RB Definition to return",
361 "description": "successful operation",
365 "$ref": "#/definitions/RbProfile"
370 "description": "Invalid status value"
375 "/rb/definition/{rbName}/{rbVersion}/profile/{profileName}": {
380 "summary": "Get RB Profile by Name",
381 "description": "Returns a single RB Profile object",
382 "operationId": "getRbProfileForRbDefinition",
390 "description": "Name of the RB Definition to return",
397 "description": "Version of the RB Definition to return",
402 "name": "profileName",
404 "description": "Name of the RB profile",
411 "description": "successful operation",
413 "$ref": "#/definitions/RbProfile"
417 "description": "Invalid identifiers supplied"
420 "description": "RB Profile not found"
428 "summary": "Deletes RB Profile",
430 "operationId": "deleteRbProfileForRbDefinition",
438 "description": "Name of the RB Definition",
445 "description": "Version of the RB Definition",
450 "name": "profileName",
452 "description": "Name of the RB profile",
459 "description": "Invalid identifiers supplied"
462 "description": "RB Definition of RB profile not found"
467 "/rb/definition/{rbName}/{rbVersion}/profile/{profileName}/content": {
472 "summary": "Uploads tgz package associated with RB Profile",
474 "operationId": "uploadRbProfileContent",
485 "description": "Name of the RB Definition",
492 "description": "Version of the RB Definition",
497 "name": "profileName",
499 "description": "Name of the RB profile",
506 "description": "successful operation",
508 "$ref": "#/definitions/ApiResponse"
519 "summary": "Create new RB Instance",
521 "operationId": "createRbInstance",
532 "description": "RB Instance properties to create",
535 "$ref": "#/definitions/RbInstanceRequest"
541 "description": "Invalid input"
549 "summary": "Get all RB Instances",
550 "description": "Multiple RB Instances",
551 "operationId": "getRbInstances",
557 "description": "successful operation",
561 "$ref": "#/definitions/RbInstance"
566 "description": "Invalid status value"
571 "/instance/{instanceId}": {
576 "summary": "Get RB Instance by ID",
577 "description": "Returns a single RB Instance object",
578 "operationId": "getRbInstanceById",
584 "name": "instanceId",
586 "description": "ID of the instance",
593 "description": "successful operation",
595 "$ref": "#/definitions/RbInstance"
599 "description": "Invalid identifiers supplied"
602 "description": "RB Definition not found"
610 "summary": "Deletes RB Instance",
612 "operationId": "deleteRbInstanceById",
618 "name": "instanceId",
620 "description": "ID of the instance",
627 "description": "Invalid identifiers supplied"
630 "description": "Rb Instance not found"
635 "/instance/{instanceId}/status": {
640 "summary": "Get RB Instance Status",
641 "description": "Returns status of a single RB Instance object",
642 "operationId": "getRbInstanceStatus",
648 "name": "instanceId",
650 "description": "ID of the instance",
657 "description": "successful operation",
659 "$ref": "#/definitions/RbInstanceStatus"
663 "description": "Invalid identifiers supplied"
666 "description": "RB Instance not found"
671 "/instance/{instanceId}/query": {
676 "summary": "Get filtered out RB Instance status",
677 "description": "Returns filtered status of a single RB Instance object",
678 "operationId": "queryRbInstanceStatus",
684 "name": "instanceId",
686 "description": "ID of the instance",
692 "name": "ApiVersion",
694 "description": "Resource ApiVersion like 'apps/v1'",
701 "description": "Resource Kind like 'Deployment'",
708 "description": "Name of Resource like 'my-pod-1'",
715 "description": "One or many pairs of label name/value data for filtering Resources like 'app=test,version=prod'",
721 "description": "successful operation",
723 "$ref": "#/definitions/RbInstanceStatus"
727 "description": "Invalid identifiers supplied"
730 "description": "RB Instance not found"
762 "chart-name": "nginx",
763 "description": "nginx definition",
787 "kubernetes-version": {
794 "profile-name": "p1",
795 "release-name": "r1",
796 "namespace": "default",
797 "kubernetes-version": "12.0.1"
813 "$ref": "#/definitions/RbInstanceRequest"
818 "$ref": "#/definitions/RbInstanceResource"
823 "RbInstanceStatus": {
830 "$ref": "#/definitions/RbInstanceRequest"
838 "$ref": "#/definitions/RbInstanceResourceStatus"
843 "RbInstanceResource": {
850 "$ref": "#/definitions/GVK"
856 "Kind": "Deployment",
862 "RbInstanceResourceStatus": {
869 "$ref": "#/definitions/GVK"
878 "Kind": "Deployment",
903 "RbInstanceRequest": {
929 "cloud-region": "kus",
930 "profile-name": "p1",
931 "release-name": "release-x",
934 "override-parameters": {
935 "optionalDictOfParameters": "andTheirValues, like",
936 "global.name": "dummy-name"
939 "optionalLabelForInternalK8spluginInstancesMetadata": "dummy-value"
948 "description": "K8s Plugin v1 API - ONAP wiki",
949 "url": "https://wiki.onap.org/display/DW/MultiCloud+K8s-Plugin-service+API"