description: No Composite App found
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
$ref: '#/components/schemas/AppData'
required: true
- put:
- tags:
- - Composite Application
- summary: Update app in Composite Application
- description: Update app in `Composite Application`
- operationId: updateAppToCompositeApplication
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/Metadata'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Application not found
- content: {}
- # request body documentation
- requestBody:
- content:
- multipart/form-data: # Media type
- schema: # Request payload
- $ref: '#/components/schemas/AppData'
- required: true
-
get: # documentation for GET operation for this path
tags:
- Composite Application
schema:
$ref: '#/components/schemas/MetadataArray'
'404':
- description: No Apps found in Composite Application found
+ description: No Apps found in Composite Application
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/apps/{app-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/apps/{app-name}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
'404':
description: Application not found
content: {}
+ put:
+ tags:
+ - Composite Application
+ summary: Update app in Composite Application
+ description: Update app in `Composite Application`
+ operationId: updateAppToCompositeApplication
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Application not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ multipart/form-data: # Media type
+ schema: # Request payload
+ $ref: '#/components/schemas/AppData'
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Composite Application
description: Composite Profile definition
required: true
- put:
- tags:
- - Composite Profile
- summary: Update Composite Profile
- description: Update `Composite Profile`
- operationId: updateCompositeProfile
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/Metadata'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Composite Profile not found
- content: {}
- # request body documentation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Metadata'
- description: Composite Profile definition
- required: true
-
get: # documentation for GET operation for this path
tags:
- Composite Profile
description: No composite profile found
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/composite-profile/{composite-profile-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/composite-profiles/{composite-profile-name}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
get: # documentation for GET operation for this path
tags:
- Composite Profile
- summary: Get Composite Application
+ summary: Get Composite Profile
description: |
Get `composite profile`
'404':
description: Composite Profile not found
content: {}
+ put:
+ tags:
+ - Composite Profile
+ summary: Update Composite Profile
+ description: Update `Composite Profile`
+ operationId: updateCompositeProfile
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Composite Profile not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ description: Composite Profile definition
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Composite Profile
description: Composite Profile not found
content: {}
- /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/composite-profile/{composite-profile-name}/profiles:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/composite-profiles/{composite-profile-name}/profiles:
parameters:
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/compositeAppName'
content:
multipart/form-data: # Media type
schema: # Request payload
- $ref: '#/components/schemas/AppData'
- put:
- tags:
- - Composite Profile
- summary: Update Composite Profile for an app
- description: Update `Profile`
- operationId: updateProfile
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/ProfileAppSpec'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Profile not found
- content: {}
- # request body documentation
- requestBody:
- content:
- multipart/form-data: # Media type
- schema: # Request payload
- $ref: '#/components/schemas/AppData'
- required: true
+ $ref: '#/components/schemas/ProfileAppData'
get: # documentation for GET operation for this path
tags:
- Composite Profile
description: No profile found
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/composite-profile/{composite-profile-name}/profiles/{profile-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/composite-profiles/{composite-profile-name}/profiles/{profile-name}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
$ref: '#/components/schemas/File'
multipart/form-data: # Media type
schema: # Request payload
- $ref: '#/components/schemas/AppData'
+ $ref: '#/components/schemas/ProfileAppData'
'404':
description: Profile not found
content: {}
+ put:
+ tags:
+ - Composite Profile
+ summary: Update Composite Profile for an app
+ description: Update `Profile`
+ operationId: updateProfile
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/ProfileAppSpec'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Profile not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ multipart/form-data: # Media type
+ schema: # Request payload
+ $ref: '#/components/schemas/ProfileAppData'
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Composite Profile
content: {}
# Qurey for Profile - Get profile for app-name
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/composite-profile/{composite-profile-name}/profiles:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/composite-profiles/{composite-profile-name}/profiles/:
parameters:
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/compositeAppName'
$ref: '#/components/schemas/File'
multipart/form-data: # Media type
schema: # Request payload
- $ref: '#/components/schemas/AppData'
+ $ref: '#/components/schemas/ProfileAppData'
'404':
description: Profile for application not found
content: {}
description: Generic Placement Intent definition
required: true
- put:
- tags:
- - Generic Placement Intent
- summary: Update Generic Placement Intent
- description: Update `Generic Placement Intent`
- operationId: updateGenericPlacementIntent
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/GenericPlacementIntent'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Generic Placement Intent not found
- content: {}
- # request body documentation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/GenericPlacementIntent'
- description: Generic Placement Intent definition
- required: true
-
get: # documentation for GET operation for this path
tags:
- Generic Placement Intent
description: No Generic Placement Intent found
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/generic-placement-intents/{generic-placement-intent-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/generic-placement-intents/{generic-placement-intent-name}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
'404':
description: Generic Placement Intent not found
content: {}
+ put:
+ tags:
+ - Generic Placement Intent
+ summary: Update Generic Placement Intent
+ description: Update `Generic Placement Intent`
+ operationId: updateGenericPlacementIntent
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/GenericPlacementIntent'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Generic Placement Intent not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GenericPlacementIntent'
+ description: Generic Placement Intent definition
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Generic Placement Intent
application/json: # Media type
schema: # Request payload
$ref: '#/components/schemas/GenericPlacementAppIntent'
- put:
- tags:
- - Generic Placement Intent
- summary: Update intent for an application
- description: Update `generic placement intent for application`
- operationId: updateIntentToGenericPlacementIntent
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/GenericPlacementAppIntent'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Generic placement intent not found
- content: {}
- # request body documentation
- requestBody:
- content:
- application/json: # Media type
- schema: # Request payload
- $ref: '#/components/schemas/GenericPlacementAppIntent'
- required: true
-
get: # documentation for GET operation for this path
tags:
- Generic Placement Intent
description: No Generic Placement Intent found
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/generic-placement-intents/{generic-placement-intent-name}/app-intents/{intent-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/generic-placement-intents/{generic-placement-intent-name}/app-intents/{intent-name}:
parameters:
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/compositeAppName'
'404':
description: Intent not found
content: {}
+ put:
+ tags:
+ - Generic Placement Intent
+ summary: Update intent for an application
+ description: Update `generic placement intent for application`
+ operationId: updateIntentToGenericPlacementIntent
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/GenericPlacementAppIntent'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Generic placement intent not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json: # Media type
+ schema: # Request payload
+ $ref: '#/components/schemas/GenericPlacementAppIntent'
+ required: true
+
delete: # documentation for DELETE operation for this path
tags:
- Generic Placement Intent
content: {}
# Qurey for Intent - Get intent for app-name
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/generic-placement-intents/{generic-placement-intent-name}/app-intents:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/generic-placement-intents/{generic-placement-intent-name}/app-intents/:
parameters:
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/compositeAppName'
$ref: '#/components/schemas/DeploymentGroupIntent'
description: Deployment Intent Group definition
required: true
-
- put:
- tags:
- - Deployment Intent Group
- summary: Update Deployment Intent Group
- description: Update `Deployment Intent Group`
- operationId: updateDeploymentIntentGroup
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/DeploymentGroupIntent'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Deployment Intent Group not found
- content: {}
- # request body documentation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DeploymentGroupIntent'
- description: Deployment Intent Group definition
- required: true
-
get: # documentation for GET operation for this path
tags:
- Deployment Intent Group
description: No Deployment Intent Group found
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
'404':
description: Deployment Intent Group not found
content: {}
+ put:
+ tags:
+ - Deployment Intent Group
+ summary: Update Deployment Intent Group
+ description: Update `Deployment Intent Group`
+ operationId: updateDeploymentIntentGroup
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/DeploymentGroupIntent'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Deployment Intent Group not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentGroupIntent'
+ description: Deployment Intent Group definition
+ required: true
+
delete: # documentation for DELETE operation for this path
tags:
- Deployment Intent Group
description: Deployment Intent Group not found
content: {}
- /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/intents:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/intents/:
parameters:
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/compositeAppName'
application/json: # Media type
schema: # Request payload
$ref: '#/components/schemas/DeploymentIntent'
- put:
- tags:
- - Deployment Intent Group
- summary: Update intent
- description: Update `deployment intent`
- operationId: updateIntentToDeploymentIntentGroup
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/DeploymentIntent'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Intent not found
- content: {}
- # request body documentation
- requestBody:
- content:
- application/json: # Media type
- schema: # Request payload
- $ref: '#/components/schemas/DeploymentIntent'
- required: true
-
get: # documentation for GET operation for this path
tags:
- Deployment Intent Group
content:
application/json: # operation response mime type
schema:
- $ref: '#/components/schemas/DeploymentGroupIntentArray'
+ $ref: '#/components/schemas/DeploymentIntentArray'
'404':
description: No Deployment Intent Group found
content: {}
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name}:
parameters:
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/compositeAppName'
'404':
description: Deployment Intent not found
content: {}
+ put:
+ tags:
+ - Deployment Intent Group
+ summary: Update intent
+ description: Update `deployment intent`
+ operationId: updateIntentToDeploymentIntentGroup
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/DeploymentIntent'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Intent not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json: # Media type
+ schema: # Request payload
+ $ref: '#/components/schemas/DeploymentIntent'
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Deployment Intent Group
description: Deployment intent not found
content: {}
#Query
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/intents:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/intents:
parameters:
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/compositeAppName'
- $ref: '#/components/parameters/compositeAppName'
- $ref: '#/components/parameters/compositeAppVersion'
- $ref: '#/components/parameters/deploymentIntentGroupName'
- post:
+ get:
tags:
- Deployment Lifecycle
summary: Status of Deployment
'200':
description: Success
content: {}
- '405':
- description: Invalid Input
+ '404':
+ description: No Status found
content: {}
- requestBody:
- content: {}
############################ Controller Registration API'S #################################################
/controllers:
$ref: '#/components/schemas/Controller'
description: Controller Info
required: true
- put:
- tags:
- - Controller Registration
- summary: Update controller
- description: Update `controller`
- operationId: updateController
- responses:
- '200':
- description: Success
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/Controller'
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Controller not found
- content: {}
- # request body documentation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Controller'
- description: Update controllers object
- required: true
-
get: # documentation for GET operation for this path
tags:
- Controller Registration
'404':
description: Controller not found
content: {}
+ put:
+ tags:
+ - Controller Registration
+ summary: Update controller
+ description: Update `controller`
+ operationId: updateController
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/Controller'
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Controller not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Controller'
+ description: Update controllers object
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Controller Registration
$ref: '#/components/schemas/Metadata'
description: Cluster Providers Info
required: true
- put:
- tags:
- - Cluster Providers
- summary: Update cluster provider
- description: Update `cluster providers`
- operationId: updateClusterProviders
- responses:
- '200':
- description: Success
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/Metadata'
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Cluster Provider not found
- content: {}
- # request body documentation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Metadata'
- description: Update cluster provider object
- required: true
-
get: # documentation for GET operation for this path
tags:
- Cluster Providers
'404':
description: Cluster Provider not found
content: {}
+ put:
+ tags:
+ - Cluster Providers
+ summary: Update cluster provider
+ description: Update `cluster providers`
+ operationId: updateClusterProviders
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Cluster Provider not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ description: Update cluster provider object
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Cluster Providers
content:
application/json: # operation response mime type
schema:
- $ref: '#/components/schemas/Metadata'
- '405':
- description: Invalid Input
- content: {}
- requestBody:
- content:
- multipart/form-data: # Media type
- schema: # Request payload
- $ref: '#/components/schemas/AppData'
- put:
- tags:
- - Clusters
- summary: Update Cluster
- description: Update `cluster`
- operationId: updateClusterToClusterProvider
- responses:
- '200':
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/Metadata'
- description: Success
- '400':
- description: Invalid data
- content: {}
- '404':
- description: Cluster not found
+ $ref: '#/components/schemas/Metadata'
+ '405':
+ description: Invalid Input
content: {}
- # request body documentation
requestBody:
content:
multipart/form-data: # Media type
schema: # Request payload
$ref: '#/components/schemas/AppData'
- required: true
+ get: # documentation for GET operation for this path
+ tags:
+ - Clusters
+ summary: Get all clusters for cluster provider
+ description: |
+ Get all `clusters for cluster provider`
+
+ operationId: getAllClusterForClusterProvider
+ responses: # list of responses
+ '200':
+ description: Success
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/MetadataArray'
+ '404':
+ description: No clusters found in cluster provider
+ content: {}
/cluster-providers/{cluster-providers-name}/clusters/{cluster-name}:
# parameters list that are used with each operation for this path
parameters:
'404':
description: Cluster not found
content: {}
+ put:
+ tags:
+ - Clusters
+ summary: Update Cluster
+ description: Update `cluster`
+ operationId: updateClusterToClusterProvider
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Cluster not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ multipart/form-data: # Media type
+ schema: # Request payload
+ $ref: '#/components/schemas/AppData'
+ required: true
+
delete: # documentation for DELETE operation for this path
tags:
- Clusters
'404':
description: label not found
content: {}
+ put:
+ tags:
+ - Clusters
+ summary: Update label
+ description: Update label for `cluster`
+ operationId: updateLabelForCluster
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/ClusterLabel'
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Label not found
+ content: {}
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClusterLabel'
+ description: Cluster Label
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Clusters
'404':
description: KV pair not found
content: {}
+ put:
+ tags:
+ - Clusters
+ summary: Update KV Pair
+ description: Update KV Pair for `cluster`
+ operationId: updateKvPairForCluster
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/ClusterKv'
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: KV Pair not found
+ content: {}
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClusterKv'
+ description: Cluster Label
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Clusters
application/json: # operation response mime type
schema:
$ref: '#/components/schemas/Metadata'
- put:
+ get: # documentation for GET operation for this path
tags:
- Network Controller Intent
- summary: Update Network Controller Intent
- description: Update `Network Controller Intent`
- operationId: updateNetworkControllerIntent
- responses:
+ summary: Get all Network Controller Intent
+
+ description: |
+ Get all `network controller intent`
+
+ operationId: getAllNetworkControllerIntent
+ responses: # list of responses
'200':
+ description: Success
content:
application/json: # operation response mime type
schema:
- $ref: '#/components/schemas/Metadata'
- description: Success
- '400':
- description: Invalid data
- content: {}
+ $ref: '#/components/schemas/MetadataArray'
'404':
- description: Network Controller Intent not found
+ description: No Network Controller Intent found
content: {}
- # request body documentation
- requestBody:
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/Metadata'
- required: true
-
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
'404':
description: Network Controller Intent not found
content: {}
+ put:
+ tags:
+ - Network Controller Intent
+ summary: Update Network Controller Intent
+ description: Update `Network Controller Intent`
+ operationId: updateNetworkControllerIntent
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Network Controller Intent not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/Metadata'
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Network Controller Intent
application/json: # operation response mime type
schema:
$ref: '#/components/schemas/NetworkWorloadSpec'
- put:
+ get: # documentation for GET operation for this path
tags:
- Network Controller Intent
- summary: Update Network Controller Workload Intent
- description: Update `Network Controller Workload Intent`
- operationId: updateNetworkControllerWorkloadIntent
- responses:
+ summary: Get Network Controller Workload Intent
+
+ description: |
+ Get all `network controller workload intent`
+
+ operationId: getAllNetworkControllerWorkloadIntent
+ responses: # list of responses
'200':
+ description: Success
content:
application/json: # operation response mime type
schema:
- $ref: '#/components/schemas/NetworkWorloadSpec'
- description: Success
- '400':
- description: Invalid data
- content: {}
+ $ref: '#/components/schemas/NetworkWorloadSpecArray'
'404':
- description: Network Controller Workload Intent not found
+ description: No Network Controller Workload Intent found
content: {}
- # request body documentation
- requestBody:
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/NetworkWorloadSpec'
- required: true
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}/workload-intents/{workload-intent-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}/workload-intents/{workload-intent-name}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
'404':
description: Network Controller Workload Intent not found
content: {}
+ put:
+ tags:
+ - Network Controller Intent
+ summary: Update Network Controller Workload Intent
+ description: Update `Network Controller Workload Intent`
+ operationId: updateNetworkControllerWorkloadIntent
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/NetworkWorloadSpec'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Network Controller Workload Intent not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/NetworkWorloadSpec'
+ required: true
delete: # documentation for DELETE operation for this path
tags:
- Network Controller Intent
application/json: # operation response mime type
schema:
$ref: '#/components/schemas/NetworkWorloadInterface'
- put:
+ get: # documentation for GET operation for this path
tags:
- Network Controller Intent
- summary: Update Network Controller Workload Interface
- description: Update `Network Controller Workload Interface`
- operationId: updateNetworkControllerWorkloadInterface
- responses:
+ summary: Get all Network Controller Workload Interface
+
+ description: |
+ Get all `network controller workload interface`
+
+ operationId: getAllNetworkControllerWorkloadInterface
+ responses: # list of responses
'200':
+ description: Success
content:
application/json: # operation response mime type
schema:
- $ref: '#/components/schemas/NetworkWorloadInterface'
- description: Success
- '400':
- description: Invalid data
- content: {}
+ $ref: '#/components/schemas/NetworkWorloadInterfaceArray'
'404':
- description: Network Controller Workload Interface not found
+ description: No Network Controller Workload Interface found
content: {}
- # request body documentation
- requestBody:
- content:
- application/json: # operation response mime type
- schema:
- $ref: '#/components/schemas/NetworkWorloadInterface'
- required: true
-
- /projects/{project-name}composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}/workload-intents/{workload-intent-name}/interfaces/{interface-name}:
+ /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}/workload-intents/{workload-intent-name}/interfaces/{interface-name}:
# parameters list that are used with each operation for this path
parameters:
- $ref: '#/components/parameters/projectName'
'404':
description: Network Controller Workload Interface not found
content: {}
+ put:
+ tags:
+ - Network Controller Intent
+ summary: Update Network Controller Workload Interface
+ description: Update `Network Controller Workload Interface`
+ operationId: updateNetworkControllerWorkloadInterface
+ responses:
+ '200':
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/NetworkWorloadInterface'
+ description: Success
+ '400':
+ description: Invalid data
+ content: {}
+ '404':
+ description: Network Controller Workload Interface not found
+ content: {}
+ # request body documentation
+ requestBody:
+ content:
+ application/json: # operation response mime type
+ schema:
+ $ref: '#/components/schemas/NetworkWorloadInterface'
+ required: true
+
delete: # documentation for DELETE operation for this path
tags:
- Network Controller Intent
- subnet
type: object
type: array
+ VirtualNetworkArray:
+ type: array
+ items:
+ $ref: '#/components/schemas/VirtualNetwork'
ProviderNetwork:
type: object
properties:
- providerNetType
- vlan
type: object
+ ProviderNetworkArray:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProviderNetwork'
RouteBasedChain:
type: object
properties:
description: Type of the workload
maxLength: 128
example: "deployment"
+ NetworkWorloadSpecArray:
+ type: array
+ items:
+ $ref: '#/components/schemas/NetworkWorloadSpec'
NetworkWorloadInterface:
type: object
properties:
type: boolean
description: Is this interface default gateway
maxLength: 128
- example: "false"
+ example: false
ipAddress:
type: string
description: Name of the network
required:
- interface
- name
+ NetworkWorloadInterfaceArray:
+ type: array
+ items:
+ $ref: '#/components/schemas/NetworkWorloadInterface'
parameters:
projectName:
name: project-name
required: true
schema:
type: string
- maxLength: 128
-
+ maxLength: 128
\ No newline at end of file