diff options
| -rw-r--r-- | docs/emco_apis.yaml | 387 |
1 files changed, 203 insertions, 184 deletions
diff --git a/docs/emco_apis.yaml b/docs/emco_apis.yaml index 5f9c5510..bef9b250 100644 --- a/docs/emco_apis.yaml +++ b/docs/emco_apis.yaml @@ -682,25 +682,26 @@ paths: content: {} -############################ GENERIC PLACEMENT INTENT API'S ################################################# - /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/generic-placement-intents: + +############################ Deployment Intent Group API'S ################################################# + /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' post: tags: - - Generic Placement Intent - summary: Add Generic Placement Intent - description: Add a new `generic placement intent` - operationId: addGenericPlacementIntent + - Deployment Intent Group + summary: Add Deployment Intent Group + description: Add a new `deployment intent group` + operationId: addDeploymentIntentGroup responses: '201': description: Success content: application/json: schema: - $ref: '#/components/schemas/GenericPlacementIntent' + $ref: '#/components/schemas/DeploymentGroupIntent' '405': description: Invalid Input content: {} @@ -708,92 +709,92 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GenericPlacementIntent' - description: Generic Placement Intent definition + $ref: '#/components/schemas/DeploymentGroupIntent' + description: Deployment Intent Group definition required: true - get: # documentation for GET operation for this path tags: - - Generic Placement Intent - summary: Get all Generic Placement Intents + - Deployment Intent Group + summary: Get all Deployment Intent Group description: | - Get all `Generic Placement Intents` + Get all `Deployment Intent Group` - operationId: getAllGenericPlacementIntents + operationId: getAllDeploymentIntentGroup responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/GenericPlacementIntentArray' + $ref: '#/components/schemas/DeploymentGroupIntentArray' '404': - description: No Generic Placement Intent found + description: No Deployment Intent Group 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}/deployment-intent-groups/{deployment-intent-group-name}: # parameters list that are used with each operation for this path parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - - $ref: '#/components/parameters/genericPlacementIntentName' + - $ref: '#/components/parameters/deploymentIntentGroupName' get: # documentation for GET operation for this path tags: - - Generic Placement Intent - summary: Get Generic Placement Intent + - Deployment Intent Group + summary: Get Deployment Intent Group description: | - Get `generic placement intent` + Get `Deployment Intent Group` - operationId: getGenericPlacementIntentByName + operationId: getDeploymentIntentGroupByName responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/GenericPlacementIntent' + $ref: '#/components/schemas/DeploymentGroupIntent' '404': - description: Generic Placement Intent not found + description: Deployment Intent Group not found content: {} put: tags: - - Generic Placement Intent - summary: Update Generic Placement Intent - description: Update `Generic Placement Intent` - operationId: updateGenericPlacementIntent + - 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/GenericPlacementIntent' + $ref: '#/components/schemas/DeploymentGroupIntent' description: Success '400': description: Invalid data content: {} '404': - description: Generic Placement Intent not found + description: Deployment Intent Group not found content: {} # request body documentation requestBody: content: application/json: schema: - $ref: '#/components/schemas/GenericPlacementIntent' - description: Generic Placement Intent definition + $ref: '#/components/schemas/DeploymentGroupIntent' + description: Deployment Intent Group definition required: true + delete: # documentation for DELETE operation for this path tags: - - Generic Placement Intent - summary: Delete Generic Placement Intent + - Deployment Intent Group + summary: Delete Deployment Intent Group description: | - Delete `Generic Placement Intent` + Delete `Deployment Intent Group` - operationId: deleteGenericPlacementIntentByName + operationId: deleteDeploymentIntentGroupByName responses: # list of responses '204': description: Deleted @@ -802,28 +803,28 @@ paths: description: Invalid data content: {} '404': - description: Generic Placement Intent not found + description: Deployment Intent Group not found content: {} - /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}/deployment-intent-groups/{deployment-intent-group-name}/intents/: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - - $ref: '#/components/parameters/genericPlacementIntentName' + - $ref: '#/components/parameters/deploymentIntentGroupName' post: tags: - - Generic Placement Intent - summary: Add intent for an application - description: Add a `intent for application` - operationId: addIntentToGenericPlacementIntent + - Deployment Intent Group + summary: Add Intent + description: Add `deployment Intent` + operationId: addIntentToDeploymentIntentGroup responses: '201': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/GenericPlacementAppIntent' + $ref: '#/components/schemas/DeploymentIntent' '405': description: Invalid Input content: {} @@ -831,91 +832,91 @@ paths: content: application/json: # Media type schema: # Request payload - $ref: '#/components/schemas/GenericPlacementAppIntent' + $ref: '#/components/schemas/DeploymentIntent' get: # documentation for GET operation for this path tags: - - Generic Placement Intent - summary: Get all Intents in Generic Placement + - Deployment Intent Group + summary: Get all intents in Deployment Intent Group description: | - Get all ` Intents in Generic Placement Intent` + Get all `intents in deployment intent group` - operationId: getAllIntentsInGenericPlacementIntents + operationId: getAllIntentsInDeploymentIntentGroup responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/GenericPlacementAppIntentArray' + $ref: '#/components/schemas/DeploymentIntentArray' '404': - description: No Generic Placement Intent found + description: No Deployment Intent Group 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}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name}: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - - $ref: '#/components/parameters/genericPlacementIntentName' + - $ref: '#/components/parameters/deploymentIntentGroupName' - $ref: '#/components/parameters/intentName' get: # documentation for GET operation for this path tags: - - Generic Placement Intent - summary: Get intent + - Deployment Intent Group + summary: Get intent for an application description: | - Get `generic placement intent` + Get `Deployment Intent` - operationId: getIntentfromGenericPlacementIntent + operationId: getIntentForDeploymentIntentGroup responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/GenericPlacementAppIntent' + $ref: '#/components/schemas/DeploymentIntent' '404': - description: Intent not found + description: Deployment Intent not found content: {} put: tags: - - Generic Placement Intent - summary: Update intent for an application - description: Update `generic placement intent for application` - operationId: updateIntentToGenericPlacementIntent + - 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/GenericPlacementAppIntent' + $ref: '#/components/schemas/DeploymentIntent' description: Success '400': description: Invalid data content: {} '404': - description: Generic placement intent not found + description: Intent not found content: {} # request body documentation requestBody: content: application/json: # Media type schema: # Request payload - $ref: '#/components/schemas/GenericPlacementAppIntent' + $ref: '#/components/schemas/DeploymentIntent' required: true - delete: # documentation for DELETE operation for this path tags: - - Generic Placement Intent + - Deployment Intent Group summary: Delete intent description: | - Delete `generic placement intent` + Delete `intent` - operationId: deleteIntentFromGenericPlacementIntent + operationId: deleteIntentFromDeploymentIntentGroup responses: # list of responses '204': description: Deleted @@ -924,18 +925,17 @@ paths: description: Invalid data content: {} '404': - description: Intent not found + description: Deployment intent not found 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/: + #Query + /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/compositeAppVersion' - - $ref: '#/components/parameters/genericPlacementIntentName' + - $ref: '#/components/parameters/deploymentIntentGroupName' - in: query - name: app-name + name: intent schema: type: string maxLength: 128 @@ -943,43 +943,44 @@ paths: get: # documentation for GET operation for this path tags: - - Generic Placement Intent - summary: Query intent for an application + - Deployment Intent Group + summary: Query intent description: | - Query `generic placement intent for application` + Query `Deployment Intent` - operationId: queryIntentfromGenericPlacementIntent + operationId: queryIntentForDeploymentIntentGroup responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/GenericPlacementAppIntent' + $ref: '#/components/schemas/DeploymentIntent' '404': - description: Generic Placement Intent for application not found + description: Deployment Intent not found content: {} -############################ Deployment Intent Group API'S ################################################# - /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups: +############################ GENERIC PLACEMENT INTENT API'S ################################################# + /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/generic-placement-intents: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' + - $ref: '#/components/parameters/deploymentIntentGroupName' post: tags: - - Deployment Intent Group - summary: Add Deployment Intent Group - description: Add a new `deployment intent group` - operationId: addDeploymentIntentGroup + - Generic Placement Intent + summary: Add Generic Placement Intent + description: Add a new `generic placement intent` + operationId: addGenericPlacementIntent responses: '201': description: Success content: application/json: schema: - $ref: '#/components/schemas/DeploymentGroupIntent' + $ref: '#/components/schemas/Metadata' '405': description: Invalid Input content: {} @@ -987,92 +988,93 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeploymentGroupIntent' - description: Deployment Intent Group definition + $ref: '#/components/schemas/Metadata' + description: Generic Placement Intent definition required: true + get: # documentation for GET operation for this path tags: - - Deployment Intent Group - summary: Get all Deployment Intent Group + - Generic Placement Intent + summary: Get all Generic Placement Intents description: | - Get all `Deployment Intent Group` + Get all `Generic Placement Intents` - operationId: getAllDeploymentIntentGroup + operationId: getAllGenericPlacementIntents responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/DeploymentGroupIntentArray' + $ref: '#/components/schemas/GenericPlacementIntentArray' '404': - description: No Deployment Intent Group found + description: No Generic Placement Intent 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}/generic-placement-intents/{generic-placement-intent-name}: # parameters list that are used with each operation for this path parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - $ref: '#/components/parameters/deploymentIntentGroupName' + - $ref: '#/components/parameters/genericPlacementIntentName' get: # documentation for GET operation for this path tags: - - Deployment Intent Group - summary: Get Deployment Intent Group + - Generic Placement Intent + summary: Get Generic Placement Intent description: | - Get `Deployment Intent Group` + Get `generic placement intent` - operationId: getDeploymentIntentGroupByName + operationId: getGenericPlacementIntentByName responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/DeploymentGroupIntent' + $ref: '#/components/schemas/Metadata' '404': - description: Deployment Intent Group not found + description: Generic Placement Intent not found content: {} put: tags: - - Deployment Intent Group - summary: Update Deployment Intent Group - description: Update `Deployment Intent Group` - operationId: updateDeploymentIntentGroup + - 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/DeploymentGroupIntent' + $ref: '#/components/schemas/Metadata' description: Success '400': description: Invalid data content: {} '404': - description: Deployment Intent Group not found + description: Generic Placement Intent not found content: {} # request body documentation requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeploymentGroupIntent' - description: Deployment Intent Group definition + $ref: '#/components/schemas/Metadata' + description: Generic Placement Intent definition required: true - delete: # documentation for DELETE operation for this path tags: - - Deployment Intent Group - summary: Delete Deployment Intent Group + - Generic Placement Intent + summary: Delete Generic Placement Intent description: | - Delete `Deployment Intent Group` + Delete `Generic Placement Intent` - operationId: deleteDeploymentIntentGroupByName + operationId: deleteGenericPlacementIntentByName responses: # list of responses '204': description: Deleted @@ -1081,28 +1083,29 @@ paths: description: Invalid data content: {} '404': - description: Deployment Intent Group not found + description: Generic Placement Intent 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}/generic-placement-intents/{generic-placement-intent-name}/app-intents: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - $ref: '#/components/parameters/deploymentIntentGroupName' + - $ref: '#/components/parameters/genericPlacementIntentName' post: tags: - - Deployment Intent Group - summary: Add Intent - description: Add `deployment Intent` - operationId: addIntentToDeploymentIntentGroup + - Generic Placement Intent + summary: Add intent for an application + description: Add a `intent for application` + operationId: addIntentToGenericPlacementIntent responses: '201': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/DeploymentIntent' + $ref: '#/components/schemas/GenericPlacementAppIntent' '405': description: Invalid Input content: {} @@ -1110,91 +1113,92 @@ paths: content: application/json: # Media type schema: # Request payload - $ref: '#/components/schemas/DeploymentIntent' + $ref: '#/components/schemas/GenericPlacementAppIntent' get: # documentation for GET operation for this path tags: - - Deployment Intent Group - summary: Get all intents in Deployment Intent Group + - Generic Placement Intent + summary: Get all Intents in Generic Placement description: | - Get all `intents in deployment intent group` + Get all ` Intents in Generic Placement Intent` - operationId: getAllIntentsInDeploymentIntentGroup + operationId: getAllIntentsInGenericPlacementIntents responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/DeploymentIntentArray' + $ref: '#/components/schemas/GenericPlacementAppIntentArray' '404': - description: No Deployment Intent Group found + description: No Generic Placement Intent 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}/generic-placement-intents/{generic-placement-intent-name}/app-intents/{intent-name}: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - $ref: '#/components/parameters/deploymentIntentGroupName' + - $ref: '#/components/parameters/genericPlacementIntentName' - $ref: '#/components/parameters/intentName' get: # documentation for GET operation for this path tags: - - Deployment Intent Group - summary: Get intent for an application + - Generic Placement Intent + summary: Get intent description: | - Get `Deployment Intent` + Get `generic placement intent` - operationId: getIntentForDeploymentIntentGroup + operationId: getIntentfromGenericPlacementIntent responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/DeploymentIntent' + $ref: '#/components/schemas/GenericPlacementAppIntent' '404': - description: Deployment Intent not found + description: Intent not found content: {} put: tags: - - Deployment Intent Group - summary: Update intent - description: Update `deployment intent` - operationId: updateIntentToDeploymentIntentGroup + - 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/DeploymentIntent' + $ref: '#/components/schemas/GenericPlacementAppIntent' description: Success '400': description: Invalid data content: {} '404': - description: Intent not found + description: Generic placement intent not found content: {} # request body documentation requestBody: content: application/json: # Media type schema: # Request payload - $ref: '#/components/schemas/DeploymentIntent' + $ref: '#/components/schemas/GenericPlacementAppIntent' required: true + delete: # documentation for DELETE operation for this path tags: - - Deployment Intent Group + - Generic Placement Intent summary: Delete intent description: | - Delete `intent` + Delete `generic placement intent` - operationId: deleteIntentFromDeploymentIntentGroup + operationId: deleteIntentFromGenericPlacementIntent responses: # list of responses '204': description: Deleted @@ -1203,17 +1207,19 @@ paths: description: Invalid data content: {} '404': - description: Deployment intent not found + description: Intent not found content: {} - #Query - /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/intents: + + # Qurey for Intent - Get intent for app-name + /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/generic-placement-intents/{generic-placement-intent-name}/app-intents/: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - $ref: '#/components/parameters/deploymentIntentGroupName' + - $ref: '#/components/parameters/genericPlacementIntentName' - in: query - name: intent + name: app-name schema: type: string maxLength: 128 @@ -1221,24 +1227,25 @@ paths: get: # documentation for GET operation for this path tags: - - Deployment Intent Group - summary: Query intent + - Generic Placement Intent + summary: Query intent for an application description: | - Query `Deployment Intent` + Query `generic placement intent for application` - operationId: queryIntentForDeploymentIntentGroup + operationId: queryIntentfromGenericPlacementIntent responses: # list of responses '200': description: Success content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/DeploymentIntent' + $ref: '#/components/schemas/GenericPlacementAppIntent' '404': - description: Deployment Intent not found + description: Generic Placement Intent for application not found content: {} + ####################Lifecycle Management####################################### /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/approve: parameters: @@ -2308,11 +2315,12 @@ paths: ######################## Network Controller Intent API's########################################## - /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent: + /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/network-controller-intent: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' + - $ref: '#/components/parameters/deploymentIntentGroupName' post: tags: - Network Controller Intent @@ -2353,12 +2361,13 @@ paths: '404': description: No Network Controller Intent found content: {} - /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}/deployment-intent-groups/{deployment-intent-group-name}/network-controller-intent/{net-control-intent}: # parameters list that are used with each operation for this path parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' + - $ref: '#/components/parameters/deploymentIntentGroupName' - $ref: '#/components/parameters/netControlIntent' get: # documentation for GET operation for this path tags: @@ -2425,11 +2434,12 @@ paths: description: Network Controller Intent not found content: {} ################## Workload Intents################################## - /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}/workload-intents: + /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/network-controller-intent/{net-control-intent}/workload-intents: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' + - $ref: '#/components/parameters/deploymentIntentGroupName' - $ref: '#/components/parameters/netControlIntent' post: tags: @@ -2443,7 +2453,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadSpec' + $ref: '#/components/schemas/NetworkWorkloadSpec' '405': description: Invalid Input content: {} @@ -2451,7 +2461,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadSpec' + $ref: '#/components/schemas/NetworkWorkloadSpec' get: # documentation for GET operation for this path tags: - Network Controller Intent @@ -2467,17 +2477,18 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadSpecArray' + $ref: '#/components/schemas/NetworkWorkloadSpecArray' '404': description: No Network Controller Workload Intent found content: {} - /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}/deployment-intent-groups/{deployment-intent-group-name}/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' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' + - $ref: '#/components/parameters/deploymentIntentGroupName' - $ref: '#/components/parameters/netControlIntent' - $ref: '#/components/parameters/netControlWorkloadIntent' get: # documentation for GET operation for this path @@ -2495,7 +2506,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadSpec' + $ref: '#/components/schemas/NetworkWorkloadSpec' '404': description: Network Controller Workload Intent not found content: {} @@ -2510,7 +2521,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadSpec' + $ref: '#/components/schemas/NetworkWorkloadSpec' description: Success '400': description: Invalid data @@ -2523,7 +2534,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadSpec' + $ref: '#/components/schemas/NetworkWorkloadSpec' required: true delete: # documentation for DELETE operation for this path tags: @@ -2546,11 +2557,12 @@ paths: content: {} ################## Workload Intents Interfaces ################################## - /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent/{net-control-intent}/workload-intents/{workload-intent-name}/interfaces: + /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/deployment-intent-groups/{deployment-intent-group-name}/network-controller-intent/{net-control-intent}/workload-intents/{workload-intent-name}/interfaces: parameters: - $ref: '#/components/parameters/projectName' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' + - $ref: '#/components/parameters/deploymentIntentGroupName' - $ref: '#/components/parameters/netControlIntent' - $ref: '#/components/parameters/netControlWorkloadIntent' post: @@ -2565,7 +2577,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadInterface' + $ref: '#/components/schemas/NetworkWorkloadInterface' '405': description: Invalid Input content: {} @@ -2573,7 +2585,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadInterface' + $ref: '#/components/schemas/NetworkWorkloadInterface' get: # documentation for GET operation for this path tags: - Network Controller Intent @@ -2589,16 +2601,17 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadInterfaceArray' + $ref: '#/components/schemas/NetworkWorkloadInterfaceArray' '404': description: No Network Controller Workload Interface found content: {} - /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}/deployment-intent-groups/{deployment-intent-group-name}/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' - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' + - $ref: '#/components/parameters/deploymentIntentGroupName' - $ref: '#/components/parameters/netControlIntent' - $ref: '#/components/parameters/netControlWorkloadIntent' - $ref: '#/components/parameters/netControlWorkloadInterface' @@ -2617,7 +2630,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadInterface' + $ref: '#/components/schemas/NetworkWorkloadInterface' '404': description: Network Controller Workload Interface not found content: {} @@ -2632,7 +2645,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadInterface' + $ref: '#/components/schemas/NetworkWorkloadInterface' description: Success '400': description: Invalid data @@ -2645,7 +2658,7 @@ paths: content: application/json: # operation response mime type schema: - $ref: '#/components/schemas/NetworkWorloadInterface' + $ref: '#/components/schemas/NetworkWorkloadInterface' required: true delete: # documentation for DELETE operation for this path @@ -2881,9 +2894,15 @@ components: version: type: string maxLength: 128 + logical-cloud: + type: string + description: Logical Cloud to use for this intent + maxLength: 128 + example: "cloud1" required: - profile - version + - logical-cloud DeploymentGroupIntent: type: object properties: @@ -3160,7 +3179,7 @@ components: - chainType - routingSpec type: object - NetworkWorloadSpec: + NetworkWorkloadSpec: type: object properties: spec: @@ -3187,11 +3206,11 @@ components: description: Type of the workload maxLength: 128 example: "deployment" - NetworkWorloadSpecArray: + NetworkWorkloadSpecArray: type: array items: - $ref: '#/components/schemas/NetworkWorloadSpec' - NetworkWorloadInterface: + $ref: '#/components/schemas/NetworkWorkloadSpec' + NetworkWorkloadInterface: type: object properties: metadata: @@ -3227,10 +3246,10 @@ components: required: - interface - name - NetworkWorloadInterfaceArray: + NetworkWorkloadInterfaceArray: type: array items: - $ref: '#/components/schemas/NetworkWorloadInterface' + $ref: '#/components/schemas/NetworkWorkloadInterface' parameters: projectName: name: project-name @@ -3298,7 +3317,7 @@ components: deploymentIntentGroupName: name: deployment-intent-group-name in: path - description: Name of Generic Placement Intent for application + description: Name of Deployment Intent Group required: true schema: type: string |