diff options
author | 2020-06-29 20:05:35 -0700 | |
---|---|---|
committer | 2020-06-29 20:05:35 -0700 | |
commit | c6ca13e3672e75f18b0ea9c6a01e65fcd78488ef (patch) | |
tree | a7301df0af0dd17b049aa218aeedcd2fdf36f246 /docs/emco_apis.yaml | |
parent | cfc671baec49dfa3350d3c9472cf08681cb8046d (diff) |
Fixing issues in OpenAPI document
Issue-ID: MULTICLOUD-1096
Signed-off-by: Ritu Sood <ritu.sood@intel.com>
Change-Id: I949fead4770e7604322a4645aaa552c54048bd31
Diffstat (limited to 'docs/emco_apis.yaml')
-rw-r--r-- | docs/emco_apis.yaml | 839 |
1 files changed, 486 insertions, 353 deletions
diff --git a/docs/emco_apis.yaml b/docs/emco_apis.yaml index b44553f7..643ac7b0 100644 --- a/docs/emco_apis.yaml +++ b/docs/emco_apis.yaml @@ -190,7 +190,7 @@ paths: 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' @@ -292,33 +292,6 @@ paths: $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 @@ -336,10 +309,10 @@ paths: 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' @@ -372,6 +345,32 @@ paths: '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 @@ -422,34 +421,6 @@ paths: 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 @@ -470,7 +441,7 @@ paths: 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' @@ -480,7 +451,7 @@ paths: get: # documentation for GET operation for this path tags: - Composite Profile - summary: Get Composite Application + summary: Get Composite Profile description: | Get `composite profile` @@ -496,6 +467,33 @@ paths: '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 @@ -516,7 +514,7 @@ paths: 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' @@ -542,33 +540,7 @@ paths: 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 @@ -589,7 +561,7 @@ paths: 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' @@ -618,11 +590,37 @@ paths: $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 @@ -644,7 +642,7 @@ paths: 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' @@ -678,7 +676,7 @@ paths: $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: {} @@ -714,34 +712,6 @@ paths: 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 @@ -762,7 +732,7 @@ paths: 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' @@ -788,6 +758,33 @@ paths: '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 @@ -835,33 +832,6 @@ paths: 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 @@ -882,7 +852,7 @@ paths: 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' @@ -910,6 +880,33 @@ paths: '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 @@ -931,7 +928,7 @@ paths: 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' @@ -993,35 +990,6 @@ paths: $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 @@ -1042,7 +1010,7 @@ paths: 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' @@ -1068,6 +1036,34 @@ paths: '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 @@ -1088,7 +1084,7 @@ paths: 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' @@ -1115,33 +1111,6 @@ paths: 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 @@ -1157,13 +1126,13 @@ paths: 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' @@ -1191,6 +1160,32 @@ paths: '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 @@ -1211,7 +1206,7 @@ paths: 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' @@ -1317,7 +1312,7 @@ paths: - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - $ref: '#/components/parameters/deploymentIntentGroupName' - post: + get: tags: - Deployment Lifecycle summary: Status of Deployment @@ -1327,11 +1322,9 @@ paths: '200': description: Success content: {} - '405': - description: Invalid Input + '404': + description: No Status found content: {} - requestBody: - content: {} ############################ Controller Registration API'S ################################################# /controllers: @@ -1358,34 +1351,6 @@ paths: $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 @@ -1429,6 +1394,33 @@ paths: '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 @@ -1474,34 +1466,6 @@ paths: $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 @@ -1545,6 +1509,33 @@ paths: '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 @@ -1589,33 +1580,25 @@ paths: multipart/form-data: # Media type schema: # Request payload $ref: '#/components/schemas/AppData' - put: + get: # documentation for GET operation for this path tags: - Clusters - summary: Update Cluster - description: Update `cluster` - operationId: updateClusterToClusterProvider - responses: + 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/Metadata' - description: Success - '400': - description: Invalid data - content: {} + $ref: '#/components/schemas/MetadataArray' '404': - description: Cluster not found + description: No clusters found in cluster provider content: {} - # request body documentation - requestBody: - content: - multipart/form-data: # Media type - schema: # Request payload - $ref: '#/components/schemas/AppData' - required: true - /cluster-providers/{cluster-providers-name}/clusters/{cluster-name}: # parameters list that are used with each operation for this path parameters: @@ -1647,6 +1630,33 @@ paths: '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 @@ -1741,6 +1751,32 @@ paths: '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 @@ -1865,6 +1901,32 @@ paths: '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 @@ -2175,34 +2237,26 @@ paths: 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' @@ -2228,6 +2282,32 @@ paths: '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 @@ -2275,34 +2355,27 @@ paths: 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' @@ -2329,6 +2402,32 @@ paths: '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 @@ -2378,34 +2477,26 @@ paths: 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' @@ -2433,6 +2524,33 @@ paths: '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 @@ -2806,6 +2924,10 @@ components: - subnet type: object type: array + VirtualNetworkArray: + type: array + items: + $ref: '#/components/schemas/VirtualNetwork' ProviderNetwork: type: object properties: @@ -2873,6 +2995,10 @@ components: - providerNetType - vlan type: object + ProviderNetworkArray: + type: array + items: + $ref: '#/components/schemas/ProviderNetwork' RouteBasedChain: type: object properties: @@ -2964,6 +3090,10 @@ components: description: Type of the workload maxLength: 128 example: "deployment" + NetworkWorloadSpecArray: + type: array + items: + $ref: '#/components/schemas/NetworkWorloadSpec' NetworkWorloadInterface: type: object properties: @@ -2986,7 +3116,7 @@ components: type: boolean description: Is this interface default gateway maxLength: 128 - example: "false" + example: false ipAddress: type: string description: Name of the network @@ -3000,6 +3130,10 @@ components: required: - interface - name + NetworkWorloadInterfaceArray: + type: array + items: + $ref: '#/components/schemas/NetworkWorloadInterface' parameters: projectName: name: project-name @@ -3143,5 +3277,4 @@ components: required: true schema: type: string - maxLength: 128 - + maxLength: 128
\ No newline at end of file |