diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java index e65b70546..0e6d69317 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java @@ -4,7 +4,7 @@ import com.sap.ai.sdk.core.model.BckndAllArgoCDApplicationData; import com.sap.ai.sdk.core.model.BckndArgoCDApplicationBaseData; import com.sap.ai.sdk.core.model.BckndArgoCDApplicationCreationResponse; -import com.sap.ai.sdk.core.model.BckndArgoCDApplicationData; +import com.sap.ai.sdk.core.model.BckndArgoCDApplicationDataResponse; import com.sap.ai.sdk.core.model.BckndArgoCDApplicationDeletionResponse; import com.sap.ai.sdk.core.model.BckndArgoCDApplicationModificationResponse; import com.sap.ai.sdk.core.model.BckndArgoCDApplicationRefreshResponse; @@ -26,7 +26,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve @@ -247,11 +247,11 @@ public BckndArgoCDApplicationDeletionResponse delete(@Nonnull final String appli * * @param applicationName (required) Name of the ArgoCD application * @param authorization (optional) Authorization bearer token containing a JWT token. - * @return BckndArgoCDApplicationData + * @return BckndArgoCDApplicationDataResponse * @throws OpenApiRequestException if an error occurs while attempting to invoke the API */ @Nonnull - public BckndArgoCDApplicationData get( + public BckndArgoCDApplicationDataResponse get( @Nonnull final String applicationName, @Nullable final String authorization) throws OpenApiRequestException { final Object localVarPostBody = null; @@ -286,8 +286,8 @@ public BckndArgoCDApplicationData get( final String[] localVarAuthNames = new String[] {"Oauth2"}; - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; return apiClient.invokeAPI( localVarPath, HttpMethod.GET, @@ -315,11 +315,11 @@ public BckndArgoCDApplicationData get( *

0 - HTTP status codes 401, 403 or 500. Response body contains further details. * * @param applicationName Name of the ArgoCD application - * @return BckndArgoCDApplicationData + * @return BckndArgoCDApplicationDataResponse * @throws OpenApiRequestException if an error occurs while attempting to invoke the API */ @Nonnull - public BckndArgoCDApplicationData get(@Nonnull final String applicationName) + public BckndArgoCDApplicationDataResponse get(@Nonnull final String applicationName) throws OpenApiRequestException { return get(applicationName, null); } diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java index 28e349fb8..a09597a18 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java index 171335e05..4a2bb1d3b 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java index 63eb9dd63..8ada88709 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java @@ -30,7 +30,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java index 5fa907bac..b24361958 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/DockerRegistrySecretApi.java @@ -24,7 +24,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java index cb5ff55d6..7bddcdb9d 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutableApi.java @@ -19,7 +19,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java index 303add8bb..dd89e8075 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionApi.java @@ -10,13 +10,6 @@ import com.sap.ai.sdk.core.model.AiExecutionModificationRequest; import com.sap.ai.sdk.core.model.AiExecutionModificationResponse; import com.sap.ai.sdk.core.model.AiExecutionResponseWithDetails; -import com.sap.ai.sdk.core.model.AiExecutionSchedule; -import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationData; -import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationResponse; -import com.sap.ai.sdk.core.model.AiExecutionScheduleDeletionResponse; -import com.sap.ai.sdk.core.model.AiExecutionScheduleList; -import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationRequest; -import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationResponse; import com.sap.ai.sdk.core.model.RTALogCommonResponse; import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient; import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService; @@ -37,7 +30,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve @@ -231,93 +224,6 @@ public Integer count(@Nonnull final String aiResourceGroup) throws OpenApiReques return count(aiResourceGroup, null, null, null, null, null); } - /** - * Get number of execution schedules - * - *

Retrieve the number of scheduled executions. The number can be filtered by configurationId - * or executionScheduleStatus. - * - *

200 - Number of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup (required) Specify a resource group id - * @param configurationId (optional) Configuration identifier - * @param status (optional) Execution Schedule status - * @return Integer - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public Integer count_0( - @Nonnull final String aiResourceGroup, - @Nullable final String configurationId, - @Nullable final String status) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling count_0"); - } - - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/$count").build().toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - localVarQueryParams.putAll( - apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"text/plain", "application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.GET, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Get number of execution schedules - * - *

Retrieve the number of scheduled executions. The number can be filtered by configurationId - * or executionScheduleStatus. - * - *

200 - Number of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup Specify a resource group id - * @return Integer - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public Integer count_0(@Nonnull final String aiResourceGroup) throws OpenApiRequestException { - return count_0(aiResourceGroup, null, null); - } - /** * Create execution * @@ -385,75 +291,6 @@ public AiExecutionCreationResponse create( localVarReturnType); } - /** - * Create execution schedule - * - *

Create an execution schedule using the configuration specified by configurationId, and - * schedule. - * - *

202 - The execution schedule has been created successfully - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup Specify a resource group id - * @param aiExecutionScheduleCreationData The value for the parameter - * aiExecutionScheduleCreationData - * @return AiExecutionScheduleCreationResponse - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleCreationResponse create_0( - @Nonnull final String aiResourceGroup, - @Nonnull final AiExecutionScheduleCreationData aiExecutionScheduleCreationData) - throws OpenApiRequestException { - final Object localVarPostBody = aiExecutionScheduleCreationData; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling create_0"); - } - - // verify the required parameter 'aiExecutionScheduleCreationData' is set - if (aiExecutionScheduleCreationData == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiExecutionScheduleCreationData' when calling create_0"); - } - - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {"application/json"}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.POST, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - /** * Mark execution as deleted * @@ -529,79 +366,6 @@ public AiExecutionDeletionResponse delete( localVarReturnType); } - /** - * Delete execution schedule - * - *

Delete the execution schedule with executionScheduleId. - * - *

202 - The execution schedule has been deleted successfully - * - *

400 - The specification of the resource was incorrect - * - *

404 - The specified resource was not found - * - * @param aiResourceGroup Specify a resource group id - * @param executionScheduleId Execution Schedule identifier - * @return AiExecutionScheduleDeletionResponse - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleDeletionResponse delete_0( - @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling delete_0"); - } - - // verify the required parameter 'executionScheduleId' is set - if (executionScheduleId == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'executionScheduleId' when calling delete_0"); - } - - // create path and map variables - final Map localVarPathParams = new HashMap(); - localVarPathParams.put("executionScheduleId", executionScheduleId); - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") - .buildAndExpand(localVarPathParams) - .toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.DELETE, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - /** * Get information about a specific execution * @@ -821,79 +585,6 @@ public RTALogCommonResponse getLogs(@Nonnull final String executionId) return getLogs(executionId, null, null, null, null, null); } - /** - * Get information about an execution schedule - * - *

Retrieve details for execution schedule with executionScheduleId. - * - *

200 - Information about the execution schedule - * - *

400 - The specification of the resource was incorrect - * - *

404 - The specified resource was not found - * - * @param aiResourceGroup Specify a resource group id - * @param executionScheduleId Execution Schedule identifier - * @return AiExecutionSchedule - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionSchedule get_0( - @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling get_0"); - } - - // verify the required parameter 'executionScheduleId' is set - if (executionScheduleId == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'executionScheduleId' when calling get_0"); - } - - // create path and map variables - final Map localVarPathParams = new HashMap(); - localVarPathParams.put("executionScheduleId", executionScheduleId); - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") - .buildAndExpand(localVarPathParams) - .toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.GET, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - /** * Update target status of an execution * @@ -979,89 +670,6 @@ public AiExecutionModificationResponse modify( localVarReturnType); } - /** - * Update an execution schedule - * - *

Update details of an execution schedule - * - *

202 - The execution schedule has been modified successfully - * - *

400 - The specification of the resource was incorrect - * - *

404 - The specified resource was not found - * - * @param aiResourceGroup Specify a resource group id - * @param executionScheduleId Execution Schedule identifier - * @param aiExecutionScheduleModificationRequest The value for the parameter - * aiExecutionScheduleModificationRequest - * @return AiExecutionScheduleModificationResponse - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleModificationResponse modify_0( - @Nonnull final String aiResourceGroup, - @Nonnull final String executionScheduleId, - @Nonnull final AiExecutionScheduleModificationRequest aiExecutionScheduleModificationRequest) - throws OpenApiRequestException { - final Object localVarPostBody = aiExecutionScheduleModificationRequest; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling modify_0"); - } - - // verify the required parameter 'executionScheduleId' is set - if (executionScheduleId == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'executionScheduleId' when calling modify_0"); - } - - // verify the required parameter 'aiExecutionScheduleModificationRequest' is set - if (aiExecutionScheduleModificationRequest == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiExecutionScheduleModificationRequest' when calling modify_0"); - } - - // create path and map variables - final Map localVarPathParams = new HashMap(); - localVarPathParams.put("executionScheduleId", executionScheduleId); - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") - .buildAndExpand(localVarPathParams) - .toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {"application/json"}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.PATCH, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - /** * Get list of executions * @@ -1176,100 +784,4 @@ public AiExecutionList query(@Nonnull final String aiResourceGroup) throws OpenApiRequestException { return query(aiResourceGroup, null, null, null, null, null, null, null, null); } - - /** - * Get list of execution schedules - * - *

Retrieve a list of execution schedules that match the specified filter criteria. Filter - * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is - * possible to paginate the result list. - * - *

200 - A list of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup (required) Specify a resource group id - * @param configurationId (optional) Configuration identifier - * @param status (optional) Execution Schedule status - * @param $top (optional, default to 10000) Number of results to display - * @param $skip (optional) Number of results to be skipped from the ordered list of results - * @return AiExecutionScheduleList - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleList query_0( - @Nonnull final String aiResourceGroup, - @Nullable final String configurationId, - @Nullable final String status, - @Nullable final Integer $top, - @Nullable final Integer $skip) - throws OpenApiRequestException { - final Object localVarPostBody = null; - - // verify the required parameter 'aiResourceGroup' is set - if (aiResourceGroup == null) { - throw new OpenApiRequestException( - "Missing the required parameter 'aiResourceGroup' when calling query_0"); - } - - final String localVarPath = - UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); - - final MultiValueMap localVarQueryParams = - new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarFormParams = - new LinkedMultiValueMap(); - - localVarQueryParams.putAll( - apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$top", $top)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$skip", $skip)); - - if (aiResourceGroup != null) - localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); - - final String[] localVarAccepts = {"application/json"}; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = {}; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - final String[] localVarAuthNames = new String[] {"Oauth2"}; - - final ParameterizedTypeReference localVarReturnType = - new ParameterizedTypeReference() {}; - return apiClient.invokeAPI( - localVarPath, - HttpMethod.GET, - localVarQueryParams, - localVarPostBody, - localVarHeaderParams, - localVarFormParams, - localVarAccept, - localVarContentType, - localVarAuthNames, - localVarReturnType); - } - - /** - * Get list of execution schedules - * - *

Retrieve a list of execution schedules that match the specified filter criteria. Filter - * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is - * possible to paginate the result list. - * - *

200 - A list of execution schedules - * - *

400 - The specification of the resource was incorrect - * - * @param aiResourceGroup Specify a resource group id - * @return AiExecutionScheduleList - * @throws OpenApiRequestException if an error occurs while attempting to invoke the API - */ - @Nonnull - public AiExecutionScheduleList query_0(@Nonnull final String aiResourceGroup) - throws OpenApiRequestException { - return query_0(aiResourceGroup, null, null, null, null); - } } diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionScheduleApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionScheduleApi.java new file mode 100644 index 000000000..a986cc590 --- /dev/null +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ExecutionScheduleApi.java @@ -0,0 +1,532 @@ +package com.sap.ai.sdk.core.client; + +import com.sap.ai.sdk.core.AiCoreService; +import com.sap.ai.sdk.core.model.AiExecutionSchedule; +import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationData; +import com.sap.ai.sdk.core.model.AiExecutionScheduleCreationResponse; +import com.sap.ai.sdk.core.model.AiExecutionScheduleDeletionResponse; +import com.sap.ai.sdk.core.model.AiExecutionScheduleList; +import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationRequest; +import com.sap.ai.sdk.core.model.AiExecutionScheduleModificationResponse; +import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService; +import com.sap.cloud.sdk.services.openapi.core.OpenApiRequestException; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; +import org.springframework.core.ParameterizedTypeReference; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.MediaType; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import org.springframework.web.util.UriComponentsBuilder; + +/** + * AI Core in version 2.42.0. + * + *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a + * batch job, for example to pre-process or train your models, or perform batch inference. Serve + * inference requests of trained models. Deploy а trained machine learning model as a web service to + * serve inference requests with high performance. Register your own Docker registry, synchronize + * your AI content from your own git repository, and register your own object store for training + * data and trained models. + */ +public class ExecutionScheduleApi extends AbstractOpenApiService { + + /** Instantiates this API class to invoke operations on the AI Core */ + public ExecutionScheduleApi() { + super(new AiCoreService().getApiClient()); + } + + /** + * Instantiates this API class to invoke operations on the AI Core + * + * @param aiCoreService The configured connectivity instance to AI Core + */ + public ExecutionScheduleApi(@Nonnull final AiCoreService aiCoreService) { + super(aiCoreService.getApiClient()); + } + + /** + * Get number of execution schedules + * + *

Retrieve the number of scheduled executions. The number can be filtered by configurationId + * or executionScheduleStatus. + * + *

200 - Number of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup (required) Specify a resource group id + * @param configurationId (optional) Configuration identifier + * @param status (optional) Execution Schedule status + * @return Integer + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public Integer count( + @Nonnull final String aiResourceGroup, + @Nullable final String configurationId, + @Nullable final String status) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling count"); + } + + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/$count").build().toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + localVarQueryParams.putAll( + apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"text/plain", "application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.GET, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Get number of execution schedules + * + *

Retrieve the number of scheduled executions. The number can be filtered by configurationId + * or executionScheduleStatus. + * + *

200 - Number of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup Specify a resource group id + * @return Integer + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public Integer count(@Nonnull final String aiResourceGroup) throws OpenApiRequestException { + return count(aiResourceGroup, null, null); + } + + /** + * Create execution schedule + * + *

Create an execution schedule using the configuration specified by configurationId, and + * schedule. + * + *

202 - The execution schedule has been created successfully + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup Specify a resource group id + * @param aiExecutionScheduleCreationData The value for the parameter + * aiExecutionScheduleCreationData + * @return AiExecutionScheduleCreationResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleCreationResponse create( + @Nonnull final String aiResourceGroup, + @Nonnull final AiExecutionScheduleCreationData aiExecutionScheduleCreationData) + throws OpenApiRequestException { + final Object localVarPostBody = aiExecutionScheduleCreationData; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling create"); + } + + // verify the required parameter 'aiExecutionScheduleCreationData' is set + if (aiExecutionScheduleCreationData == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiExecutionScheduleCreationData' when calling create"); + } + + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {"application/json"}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.POST, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Delete execution schedule + * + *

Delete the execution schedule with executionScheduleId. + * + *

202 - The execution schedule has been deleted successfully + * + *

400 - The specification of the resource was incorrect + * + *

404 - The specified resource was not found + * + * @param aiResourceGroup Specify a resource group id + * @param executionScheduleId Execution Schedule identifier + * @return AiExecutionScheduleDeletionResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleDeletionResponse delete( + @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling delete"); + } + + // verify the required parameter 'executionScheduleId' is set + if (executionScheduleId == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'executionScheduleId' when calling delete"); + } + + // create path and map variables + final Map localVarPathParams = new HashMap(); + localVarPathParams.put("executionScheduleId", executionScheduleId); + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") + .buildAndExpand(localVarPathParams) + .toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.DELETE, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Get information about an execution schedule + * + *

Retrieve details for execution schedule with executionScheduleId. + * + *

200 - Information about the execution schedule + * + *

400 - The specification of the resource was incorrect + * + *

404 - The specified resource was not found + * + * @param aiResourceGroup Specify a resource group id + * @param executionScheduleId Execution Schedule identifier + * @return AiExecutionSchedule + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionSchedule get( + @Nonnull final String aiResourceGroup, @Nonnull final String executionScheduleId) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling get"); + } + + // verify the required parameter 'executionScheduleId' is set + if (executionScheduleId == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'executionScheduleId' when calling get"); + } + + // create path and map variables + final Map localVarPathParams = new HashMap(); + localVarPathParams.put("executionScheduleId", executionScheduleId); + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") + .buildAndExpand(localVarPathParams) + .toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.GET, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Update an execution schedule + * + *

Update details of an execution schedule + * + *

202 - The execution schedule has been modified successfully + * + *

400 - The specification of the resource was incorrect + * + *

404 - The specified resource was not found + * + * @param aiResourceGroup Specify a resource group id + * @param executionScheduleId Execution Schedule identifier + * @param aiExecutionScheduleModificationRequest The value for the parameter + * aiExecutionScheduleModificationRequest + * @return AiExecutionScheduleModificationResponse + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleModificationResponse modify( + @Nonnull final String aiResourceGroup, + @Nonnull final String executionScheduleId, + @Nonnull final AiExecutionScheduleModificationRequest aiExecutionScheduleModificationRequest) + throws OpenApiRequestException { + final Object localVarPostBody = aiExecutionScheduleModificationRequest; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling modify"); + } + + // verify the required parameter 'executionScheduleId' is set + if (executionScheduleId == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'executionScheduleId' when calling modify"); + } + + // verify the required parameter 'aiExecutionScheduleModificationRequest' is set + if (aiExecutionScheduleModificationRequest == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiExecutionScheduleModificationRequest' when calling modify"); + } + + // create path and map variables + final Map localVarPathParams = new HashMap(); + localVarPathParams.put("executionScheduleId", executionScheduleId); + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules/{executionScheduleId}") + .buildAndExpand(localVarPathParams) + .toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {"application/json"}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.PATCH, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Get list of execution schedules + * + *

Retrieve a list of execution schedules that match the specified filter criteria. Filter + * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is + * possible to paginate the result list. + * + *

200 - A list of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup (required) Specify a resource group id + * @param configurationId (optional) Configuration identifier + * @param status (optional) Execution Schedule status + * @param $top (optional, default to 10000) Number of results to display + * @param $skip (optional) Number of results to be skipped from the ordered list of results + * @return AiExecutionScheduleList + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleList query( + @Nonnull final String aiResourceGroup, + @Nullable final String configurationId, + @Nullable final String status, + @Nullable final Integer $top, + @Nullable final Integer $skip) + throws OpenApiRequestException { + final Object localVarPostBody = null; + + // verify the required parameter 'aiResourceGroup' is set + if (aiResourceGroup == null) { + throw new OpenApiRequestException( + "Missing the required parameter 'aiResourceGroup' when calling query"); + } + + final String localVarPath = + UriComponentsBuilder.fromPath("/lm/executionSchedules").build().toUriString(); + + final MultiValueMap localVarQueryParams = + new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarFormParams = + new LinkedMultiValueMap(); + + localVarQueryParams.putAll( + apiClient.parameterToMultiValueMap(null, "configurationId", configurationId)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "status", status)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$top", $top)); + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "$skip", $skip)); + + if (aiResourceGroup != null) + localVarHeaderParams.add("AI-Resource-Group", apiClient.parameterToString(aiResourceGroup)); + + final String[] localVarAccepts = {"application/json"}; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = {}; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + final String[] localVarAuthNames = new String[] {"Oauth2"}; + + final ParameterizedTypeReference localVarReturnType = + new ParameterizedTypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + HttpMethod.GET, + localVarQueryParams, + localVarPostBody, + localVarHeaderParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType); + } + + /** + * Get list of execution schedules + * + *

Retrieve a list of execution schedules that match the specified filter criteria. Filter + * criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is + * possible to paginate the result list. + * + *

200 - A list of execution schedules + * + *

400 - The specification of the resource was incorrect + * + * @param aiResourceGroup Specify a resource group id + * @return AiExecutionScheduleList + * @throws OpenApiRequestException if an error occurs while attempting to invoke the API + */ + @Nonnull + public AiExecutionScheduleList query(@Nonnull final String aiResourceGroup) + throws OpenApiRequestException { + return query(aiResourceGroup, null, null, null, null); + } +} diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java index d0c5126da..18d9f2a98 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/FileApi.java @@ -20,7 +20,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java index 1b3591e61..68e5f6e16 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/KpiApi.java @@ -20,7 +20,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java index 464c23f42..9a1c67514 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/MetaApi.java @@ -15,7 +15,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java index 15c1e6642..dc42ba40d 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/MetricsApi.java @@ -21,7 +21,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java index 7a871e518..820778aaf 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ObjectStoreSecretApi.java @@ -24,7 +24,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java index b4a42aa2c..7d7ea29b8 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/RepositoryApi.java @@ -24,7 +24,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java index 71f898a76..4da48a042 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceApi.java @@ -19,7 +19,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java index 5aaeab219..602fc252e 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceGroupApi.java @@ -26,7 +26,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java index f07c93007..8b947427b 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ResourceQuotaApi.java @@ -18,7 +18,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java index 620ed4c14..75f7ff655 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ScenarioApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java index 1a4c34a9e..ac706ee45 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/SecretApi.java @@ -23,7 +23,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java index 4f5ec0a4d..3e774d892 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/ServiceApi.java @@ -19,7 +19,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java b/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java index 144578c81..3e13368f9 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java +++ b/core/src/main/java/com/sap/ai/sdk/core/client/TenantInfoApi.java @@ -15,7 +15,7 @@ import org.springframework.web.util.UriComponentsBuilder; /** - * AI Core in version 2.41.0. + * AI Core in version 2.42.0. * *

Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a * batch job, for example to pre-process or train your models, or perform batch inference. Serve diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndAllArgoCDApplicationData.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndAllArgoCDApplicationData.java index 31d848544..82cd2d23b 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndAllArgoCDApplicationData.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndAllArgoCDApplicationData.java @@ -35,7 +35,7 @@ public class BckndAllArgoCDApplicationData private Integer count; @JsonProperty("resources") - private List resources = new ArrayList<>(); + private List resources = new ArrayList<>(); @JsonAnySetter @JsonAnyGetter private final Map cloudSdkCustomFields = new LinkedHashMap<>(); @@ -84,7 +84,7 @@ public void setCount(@Nonnull final Integer count) { */ @Nonnull public BckndAllArgoCDApplicationData resources( - @Nonnull final List resources) { + @Nonnull final List resources) { this.resources = resources; return this; } @@ -97,7 +97,7 @@ public BckndAllArgoCDApplicationData resources( */ @Nonnull public BckndAllArgoCDApplicationData addResourcesItem( - @Nonnull final BckndArgoCDApplicationData resourcesItem) { + @Nonnull final BckndArgoCDApplicationDataResponse resourcesItem) { if (this.resources == null) { this.resources = new ArrayList<>(); } @@ -111,7 +111,7 @@ public BckndAllArgoCDApplicationData addResourcesItem( * @return resources The resources of this {@link BckndAllArgoCDApplicationData} instance. */ @Nonnull - public List getResources() { + public List getResources() { return resources; } @@ -120,7 +120,7 @@ public List getResources() { * * @param resources The resources of this {@link BckndAllArgoCDApplicationData} */ - public void setResources(@Nonnull final List resources) { + public void setResources(@Nonnull final List resources) { this.resources = resources; } @@ -256,7 +256,7 @@ public interface Builder1 { * @return The BckndAllArgoCDApplicationData instance. */ BckndAllArgoCDApplicationData resources( - @Nonnull final List resources); + @Nonnull final List resources); /** * Set the resources of this {@link BckndAllArgoCDApplicationData} instance. @@ -265,7 +265,7 @@ BckndAllArgoCDApplicationData resources( * @return The BckndAllArgoCDApplicationData instance. */ default BckndAllArgoCDApplicationData resources( - @Nonnull final BckndArgoCDApplicationData... resources) { + @Nonnull final BckndArgoCDApplicationDataResponse... resources) { return resources(Arrays.asList(resources)); } } diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataRepoName.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataRepoName.java index 5338df7b8..a0d1e0f7a 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataRepoName.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataRepoName.java @@ -147,7 +147,7 @@ public void setPath(@Nonnull final String path) { * Set the applicationName of this {@link BckndArgoCDApplicationDataRepoName} instance and return * the same instance. * - * @param applicationName ArgoCD application name + * @param applicationName ArgoCD application name in the request body * @return The same instance of this {@link BckndArgoCDApplicationDataRepoName} class */ @Nonnull @@ -158,7 +158,7 @@ public BckndArgoCDApplicationDataRepoName applicationName( } /** - * ArgoCD application name + * ArgoCD application name in the request body * * @return applicationName The applicationName of this {@link BckndArgoCDApplicationDataRepoName} * instance. @@ -171,7 +171,7 @@ public String getApplicationName() { /** * Set the applicationName of this {@link BckndArgoCDApplicationDataRepoName} instance. * - * @param applicationName ArgoCD application name + * @param applicationName ArgoCD application name in the request body */ public void setApplicationName(@Nullable final String applicationName) { this.applicationName = applicationName; diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationData.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataRequest.java similarity index 74% rename from core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationData.java rename to core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataRequest.java index b6f573657..351704cd1 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationData.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataRequest.java @@ -23,9 +23,9 @@ import javax.annotation.Nonnull; import javax.annotation.Nullable; -/** BckndArgoCDApplicationData */ +/** BckndArgoCDApplicationDataRequest */ // CHECKSTYLE:OFF -public class BckndArgoCDApplicationData +public class BckndArgoCDApplicationDataRequest // CHECKSTYLE:ON { @JsonProperty("repositoryUrl") @@ -43,18 +43,18 @@ public class BckndArgoCDApplicationData @JsonAnySetter @JsonAnyGetter private final Map cloudSdkCustomFields = new LinkedHashMap<>(); - /** Default constructor for BckndArgoCDApplicationData. */ - protected BckndArgoCDApplicationData() {} + /** Default constructor for BckndArgoCDApplicationDataRequest. */ + protected BckndArgoCDApplicationDataRequest() {} /** - * Set the repositoryUrl of this {@link BckndArgoCDApplicationData} instance and return the same - * instance. + * Set the repositoryUrl of this {@link BckndArgoCDApplicationDataRequest} instance and return the + * same instance. * * @param repositoryUrl URL of the repository to synchronise - * @return The same instance of this {@link BckndArgoCDApplicationData} class + * @return The same instance of this {@link BckndArgoCDApplicationDataRequest} class */ @Nonnull - public BckndArgoCDApplicationData repositoryUrl(@Nonnull final String repositoryUrl) { + public BckndArgoCDApplicationDataRequest repositoryUrl(@Nonnull final String repositoryUrl) { this.repositoryUrl = repositoryUrl; return this; } @@ -62,7 +62,8 @@ public BckndArgoCDApplicationData repositoryUrl(@Nonnull final String repository /** * URL of the repository to synchronise * - * @return repositoryUrl The repositoryUrl of this {@link BckndArgoCDApplicationData} instance. + * @return repositoryUrl The repositoryUrl of this {@link BckndArgoCDApplicationDataRequest} + * instance. */ @Nonnull public String getRepositoryUrl() { @@ -70,7 +71,7 @@ public String getRepositoryUrl() { } /** - * Set the repositoryUrl of this {@link BckndArgoCDApplicationData} instance. + * Set the repositoryUrl of this {@link BckndArgoCDApplicationDataRequest} instance. * * @param repositoryUrl URL of the repository to synchronise */ @@ -79,14 +80,14 @@ public void setRepositoryUrl(@Nonnull final String repositoryUrl) { } /** - * Set the revision of this {@link BckndArgoCDApplicationData} instance and return the same + * Set the revision of this {@link BckndArgoCDApplicationDataRequest} instance and return the same * instance. * * @param revision revision to synchronise - * @return The same instance of this {@link BckndArgoCDApplicationData} class + * @return The same instance of this {@link BckndArgoCDApplicationDataRequest} class */ @Nonnull - public BckndArgoCDApplicationData revision(@Nonnull final String revision) { + public BckndArgoCDApplicationDataRequest revision(@Nonnull final String revision) { this.revision = revision; return this; } @@ -94,7 +95,7 @@ public BckndArgoCDApplicationData revision(@Nonnull final String revision) { /** * revision to synchronise * - * @return revision The revision of this {@link BckndArgoCDApplicationData} instance. + * @return revision The revision of this {@link BckndArgoCDApplicationDataRequest} instance. */ @Nonnull public String getRevision() { @@ -102,7 +103,7 @@ public String getRevision() { } /** - * Set the revision of this {@link BckndArgoCDApplicationData} instance. + * Set the revision of this {@link BckndArgoCDApplicationDataRequest} instance. * * @param revision revision to synchronise */ @@ -111,13 +112,14 @@ public void setRevision(@Nonnull final String revision) { } /** - * Set the path of this {@link BckndArgoCDApplicationData} instance and return the same instance. + * Set the path of this {@link BckndArgoCDApplicationDataRequest} instance and return the same + * instance. * * @param path path within the repository to synchronise - * @return The same instance of this {@link BckndArgoCDApplicationData} class + * @return The same instance of this {@link BckndArgoCDApplicationDataRequest} class */ @Nonnull - public BckndArgoCDApplicationData path(@Nonnull final String path) { + public BckndArgoCDApplicationDataRequest path(@Nonnull final String path) { this.path = path; return this; } @@ -125,7 +127,7 @@ public BckndArgoCDApplicationData path(@Nonnull final String path) { /** * path within the repository to synchronise * - * @return path The path of this {@link BckndArgoCDApplicationData} instance. + * @return path The path of this {@link BckndArgoCDApplicationDataRequest} instance. */ @Nonnull public String getPath() { @@ -133,7 +135,7 @@ public String getPath() { } /** - * Set the path of this {@link BckndArgoCDApplicationData} instance. + * Set the path of this {@link BckndArgoCDApplicationDataRequest} instance. * * @param path path within the repository to synchronise */ @@ -142,22 +144,22 @@ public void setPath(@Nonnull final String path) { } /** - * Set the applicationName of this {@link BckndArgoCDApplicationData} instance and return the same - * instance. + * Set the applicationName of this {@link BckndArgoCDApplicationDataRequest} instance and return + * the same instance. * - * @param applicationName ArgoCD application name - * @return The same instance of this {@link BckndArgoCDApplicationData} class + * @param applicationName ArgoCD application name in the request body + * @return The same instance of this {@link BckndArgoCDApplicationDataRequest} class */ @Nonnull - public BckndArgoCDApplicationData applicationName(@Nullable final String applicationName) { + public BckndArgoCDApplicationDataRequest applicationName(@Nullable final String applicationName) { this.applicationName = applicationName; return this; } /** - * ArgoCD application name + * ArgoCD application name in the request body * - * @return applicationName The applicationName of this {@link BckndArgoCDApplicationData} + * @return applicationName The applicationName of this {@link BckndArgoCDApplicationDataRequest} * instance. */ @Nonnull @@ -166,16 +168,17 @@ public String getApplicationName() { } /** - * Set the applicationName of this {@link BckndArgoCDApplicationData} instance. + * Set the applicationName of this {@link BckndArgoCDApplicationDataRequest} instance. * - * @param applicationName ArgoCD application name + * @param applicationName ArgoCD application name in the request body */ public void setApplicationName(@Nullable final String applicationName) { this.applicationName = applicationName; } /** - * Get the names of the unrecognizable properties of the {@link BckndArgoCDApplicationData}. + * Get the names of the unrecognizable properties of the {@link + * BckndArgoCDApplicationDataRequest}. * * @return The set of properties names */ @@ -186,7 +189,7 @@ public Set getCustomFieldNames() { } /** - * Get the value of an unrecognizable property of this {@link BckndArgoCDApplicationData} + * Get the value of an unrecognizable property of this {@link BckndArgoCDApplicationDataRequest} * instance. * * @deprecated Use {@link #toMap()} instead. @@ -199,14 +202,14 @@ public Set getCustomFieldNames() { public Object getCustomField(@Nonnull final String name) throws NoSuchElementException { if (!cloudSdkCustomFields.containsKey(name)) { throw new NoSuchElementException( - "BckndArgoCDApplicationData has no field with name '" + name + "'."); + "BckndArgoCDApplicationDataRequest has no field with name '" + name + "'."); } return cloudSdkCustomFields.get(name); } /** - * Get the value of all properties of this {@link BckndArgoCDApplicationData} instance including - * unrecognized properties. + * Get the value of all properties of this {@link BckndArgoCDApplicationDataRequest} instance + * including unrecognized properties. * * @return The map of all properties */ @@ -222,8 +225,9 @@ public Map toMap() { } /** - * Set an unrecognizable property of this {@link BckndArgoCDApplicationData} instance. If the map - * previously contained a mapping for the key, the old value is replaced by the specified value. + * Set an unrecognizable property of this {@link BckndArgoCDApplicationDataRequest} instance. If + * the map previously contained a mapping for the key, the old value is replaced by the specified + * value. * * @param customFieldName The name of the property * @param customFieldValue The value of the property @@ -241,13 +245,14 @@ public boolean equals(@Nullable final java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - final BckndArgoCDApplicationData bckndArgoCDApplicationData = (BckndArgoCDApplicationData) o; + final BckndArgoCDApplicationDataRequest bckndArgoCDApplicationDataRequest = + (BckndArgoCDApplicationDataRequest) o; return Objects.equals( - this.cloudSdkCustomFields, bckndArgoCDApplicationData.cloudSdkCustomFields) - && Objects.equals(this.repositoryUrl, bckndArgoCDApplicationData.repositoryUrl) - && Objects.equals(this.revision, bckndArgoCDApplicationData.revision) - && Objects.equals(this.path, bckndArgoCDApplicationData.path) - && Objects.equals(this.applicationName, bckndArgoCDApplicationData.applicationName); + this.cloudSdkCustomFields, bckndArgoCDApplicationDataRequest.cloudSdkCustomFields) + && Objects.equals(this.repositoryUrl, bckndArgoCDApplicationDataRequest.repositoryUrl) + && Objects.equals(this.revision, bckndArgoCDApplicationDataRequest.revision) + && Objects.equals(this.path, bckndArgoCDApplicationDataRequest.path) + && Objects.equals(this.applicationName, bckndArgoCDApplicationDataRequest.applicationName); } @Override @@ -259,7 +264,7 @@ public int hashCode() { @Nonnull public String toString() { final StringBuilder sb = new StringBuilder(); - sb.append("class BckndArgoCDApplicationData {\n"); + sb.append("class BckndArgoCDApplicationDataRequest {\n"); sb.append(" repositoryUrl: ").append(toIndentedString(repositoryUrl)).append("\n"); sb.append(" revision: ").append(toIndentedString(revision)).append("\n"); sb.append(" path: ").append(toIndentedString(path)).append("\n"); @@ -283,13 +288,13 @@ private String toIndentedString(final java.lang.Object o) { /** * Create a type-safe, fluent-api builder object to construct a new {@link - * BckndArgoCDApplicationData} instance with all required arguments. + * BckndArgoCDApplicationDataRequest} instance with all required arguments. */ public static Builder create() { return (repositoryUrl) -> (revision) -> (path) -> - new BckndArgoCDApplicationData() + new BckndArgoCDApplicationDataRequest() .repositoryUrl(repositoryUrl) .revision(revision) .path(path); @@ -298,10 +303,10 @@ public static Builder create() { /** Builder helper class. */ public interface Builder { /** - * Set the repositoryUrl of this {@link BckndArgoCDApplicationData} instance. + * Set the repositoryUrl of this {@link BckndArgoCDApplicationDataRequest} instance. * * @param repositoryUrl URL of the repository to synchronise - * @return The BckndArgoCDApplicationData builder. + * @return The BckndArgoCDApplicationDataRequest builder. */ Builder1 repositoryUrl(@Nonnull final String repositoryUrl); } @@ -309,10 +314,10 @@ public interface Builder { /** Builder helper class. */ public interface Builder1 { /** - * Set the revision of this {@link BckndArgoCDApplicationData} instance. + * Set the revision of this {@link BckndArgoCDApplicationDataRequest} instance. * * @param revision revision to synchronise - * @return The BckndArgoCDApplicationData builder. + * @return The BckndArgoCDApplicationDataRequest builder. */ Builder2 revision(@Nonnull final String revision); } @@ -320,11 +325,11 @@ public interface Builder1 { /** Builder helper class. */ public interface Builder2 { /** - * Set the path of this {@link BckndArgoCDApplicationData} instance. + * Set the path of this {@link BckndArgoCDApplicationDataRequest} instance. * * @param path path within the repository to synchronise - * @return The BckndArgoCDApplicationData instance. + * @return The BckndArgoCDApplicationDataRequest instance. */ - BckndArgoCDApplicationData path(@Nonnull final String path); + BckndArgoCDApplicationDataRequest path(@Nonnull final String path); } } diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataResponse.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataResponse.java new file mode 100644 index 000000000..46886d8e4 --- /dev/null +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndArgoCDApplicationDataResponse.java @@ -0,0 +1,336 @@ +/* + * AI Core + * Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a batch job, for example to pre-process or train your models, or perform batch inference. Serve inference requests of trained models. Deploy а trained machine learning model as a web service to serve inference requests with high performance. Register your own Docker registry, synchronize your AI content from your own git repository, and register your own object store for training data and trained models. + * + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.sap.ai.sdk.core.model; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.NoSuchElementException; +import java.util.Objects; +import java.util.Set; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; + +/** BckndArgoCDApplicationDataResponse */ +// CHECKSTYLE:OFF +public class BckndArgoCDApplicationDataResponse +// CHECKSTYLE:ON +{ + @JsonProperty("repositoryUrl") + private String repositoryUrl; + + @JsonProperty("revision") + private String revision; + + @JsonProperty("path") + private String path; + + @JsonProperty("applicationName") + private String applicationName; + + @JsonAnySetter @JsonAnyGetter + private final Map cloudSdkCustomFields = new LinkedHashMap<>(); + + /** Default constructor for BckndArgoCDApplicationDataResponse. */ + protected BckndArgoCDApplicationDataResponse() {} + + /** + * Set the repositoryUrl of this {@link BckndArgoCDApplicationDataResponse} instance and return + * the same instance. + * + * @param repositoryUrl URL of the repository to synchronise + * @return The same instance of this {@link BckndArgoCDApplicationDataResponse} class + */ + @Nonnull + public BckndArgoCDApplicationDataResponse repositoryUrl(@Nonnull final String repositoryUrl) { + this.repositoryUrl = repositoryUrl; + return this; + } + + /** + * URL of the repository to synchronise + * + * @return repositoryUrl The repositoryUrl of this {@link BckndArgoCDApplicationDataResponse} + * instance. + */ + @Nonnull + public String getRepositoryUrl() { + return repositoryUrl; + } + + /** + * Set the repositoryUrl of this {@link BckndArgoCDApplicationDataResponse} instance. + * + * @param repositoryUrl URL of the repository to synchronise + */ + public void setRepositoryUrl(@Nonnull final String repositoryUrl) { + this.repositoryUrl = repositoryUrl; + } + + /** + * Set the revision of this {@link BckndArgoCDApplicationDataResponse} instance and return the + * same instance. + * + * @param revision revision to synchronise + * @return The same instance of this {@link BckndArgoCDApplicationDataResponse} class + */ + @Nonnull + public BckndArgoCDApplicationDataResponse revision(@Nonnull final String revision) { + this.revision = revision; + return this; + } + + /** + * revision to synchronise + * + * @return revision The revision of this {@link BckndArgoCDApplicationDataResponse} instance. + */ + @Nonnull + public String getRevision() { + return revision; + } + + /** + * Set the revision of this {@link BckndArgoCDApplicationDataResponse} instance. + * + * @param revision revision to synchronise + */ + public void setRevision(@Nonnull final String revision) { + this.revision = revision; + } + + /** + * Set the path of this {@link BckndArgoCDApplicationDataResponse} instance and return the same + * instance. + * + * @param path path within the repository to synchronise + * @return The same instance of this {@link BckndArgoCDApplicationDataResponse} class + */ + @Nonnull + public BckndArgoCDApplicationDataResponse path(@Nonnull final String path) { + this.path = path; + return this; + } + + /** + * path within the repository to synchronise + * + * @return path The path of this {@link BckndArgoCDApplicationDataResponse} instance. + */ + @Nonnull + public String getPath() { + return path; + } + + /** + * Set the path of this {@link BckndArgoCDApplicationDataResponse} instance. + * + * @param path path within the repository to synchronise + */ + public void setPath(@Nonnull final String path) { + this.path = path; + } + + /** + * Set the applicationName of this {@link BckndArgoCDApplicationDataResponse} instance and return + * the same instance. + * + * @param applicationName ArgoCD application name in the response body + * @return The same instance of this {@link BckndArgoCDApplicationDataResponse} class + */ + @Nonnull + public BckndArgoCDApplicationDataResponse applicationName( + @Nullable final String applicationName) { + this.applicationName = applicationName; + return this; + } + + /** + * ArgoCD application name in the response body + * + * @return applicationName The applicationName of this {@link BckndArgoCDApplicationDataResponse} + * instance. + */ + @Nonnull + public String getApplicationName() { + return applicationName; + } + + /** + * Set the applicationName of this {@link BckndArgoCDApplicationDataResponse} instance. + * + * @param applicationName ArgoCD application name in the response body + */ + public void setApplicationName(@Nullable final String applicationName) { + this.applicationName = applicationName; + } + + /** + * Get the names of the unrecognizable properties of the {@link + * BckndArgoCDApplicationDataResponse}. + * + * @return The set of properties names + */ + @JsonIgnore + @Nonnull + public Set getCustomFieldNames() { + return cloudSdkCustomFields.keySet(); + } + + /** + * Get the value of an unrecognizable property of this {@link BckndArgoCDApplicationDataResponse} + * instance. + * + * @deprecated Use {@link #toMap()} instead. + * @param name The name of the property + * @return The value of the property + * @throws NoSuchElementException If no property with the given name could be found. + */ + @Nullable + @Deprecated + public Object getCustomField(@Nonnull final String name) throws NoSuchElementException { + if (!cloudSdkCustomFields.containsKey(name)) { + throw new NoSuchElementException( + "BckndArgoCDApplicationDataResponse has no field with name '" + name + "'."); + } + return cloudSdkCustomFields.get(name); + } + + /** + * Get the value of all properties of this {@link BckndArgoCDApplicationDataResponse} instance + * including unrecognized properties. + * + * @return The map of all properties + */ + @JsonIgnore + @Nonnull + public Map toMap() { + final Map declaredFields = new LinkedHashMap<>(cloudSdkCustomFields); + if (repositoryUrl != null) declaredFields.put("repositoryUrl", repositoryUrl); + if (revision != null) declaredFields.put("revision", revision); + if (path != null) declaredFields.put("path", path); + if (applicationName != null) declaredFields.put("applicationName", applicationName); + return declaredFields; + } + + /** + * Set an unrecognizable property of this {@link BckndArgoCDApplicationDataResponse} instance. If + * the map previously contained a mapping for the key, the old value is replaced by the specified + * value. + * + * @param customFieldName The name of the property + * @param customFieldValue The value of the property + */ + @JsonIgnore + public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue) { + cloudSdkCustomFields.put(customFieldName, customFieldValue); + } + + @Override + public boolean equals(@Nullable final java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + final BckndArgoCDApplicationDataResponse bckndArgoCDApplicationDataResponse = + (BckndArgoCDApplicationDataResponse) o; + return Objects.equals( + this.cloudSdkCustomFields, bckndArgoCDApplicationDataResponse.cloudSdkCustomFields) + && Objects.equals(this.repositoryUrl, bckndArgoCDApplicationDataResponse.repositoryUrl) + && Objects.equals(this.revision, bckndArgoCDApplicationDataResponse.revision) + && Objects.equals(this.path, bckndArgoCDApplicationDataResponse.path) + && Objects.equals(this.applicationName, bckndArgoCDApplicationDataResponse.applicationName); + } + + @Override + public int hashCode() { + return Objects.hash(repositoryUrl, revision, path, applicationName, cloudSdkCustomFields); + } + + @Override + @Nonnull + public String toString() { + final StringBuilder sb = new StringBuilder(); + sb.append("class BckndArgoCDApplicationDataResponse {\n"); + sb.append(" repositoryUrl: ").append(toIndentedString(repositoryUrl)).append("\n"); + sb.append(" revision: ").append(toIndentedString(revision)).append("\n"); + sb.append(" path: ").append(toIndentedString(path)).append("\n"); + sb.append(" applicationName: ").append(toIndentedString(applicationName)).append("\n"); + cloudSdkCustomFields.forEach( + (k, v) -> + sb.append(" ").append(k).append(": ").append(toIndentedString(v)).append("\n")); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first line). + */ + private String toIndentedString(final java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Create a type-safe, fluent-api builder object to construct a new {@link + * BckndArgoCDApplicationDataResponse} instance with all required arguments. + */ + public static Builder create() { + return (repositoryUrl) -> + (revision) -> + (path) -> + new BckndArgoCDApplicationDataResponse() + .repositoryUrl(repositoryUrl) + .revision(revision) + .path(path); + } + + /** Builder helper class. */ + public interface Builder { + /** + * Set the repositoryUrl of this {@link BckndArgoCDApplicationDataResponse} instance. + * + * @param repositoryUrl URL of the repository to synchronise + * @return The BckndArgoCDApplicationDataResponse builder. + */ + Builder1 repositoryUrl(@Nonnull final String repositoryUrl); + } + + /** Builder helper class. */ + public interface Builder1 { + /** + * Set the revision of this {@link BckndArgoCDApplicationDataResponse} instance. + * + * @param revision revision to synchronise + * @return The BckndArgoCDApplicationDataResponse builder. + */ + Builder2 revision(@Nonnull final String revision); + } + + /** Builder helper class. */ + public interface Builder2 { + /** + * Set the path of this {@link BckndArgoCDApplicationDataResponse} instance. + * + * @param path path within the repository to synchronise + * @return The BckndArgoCDApplicationDataResponse instance. + */ + BckndArgoCDApplicationDataResponse path(@Nonnull final String path); + } +} diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndEvent.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndEvent.java deleted file mode 100644 index 5b9cb2b0e..000000000 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndEvent.java +++ /dev/null @@ -1,438 +0,0 @@ -/* - * AI Core - * Provides tools to manage your scenarios and workflows in SAP AI Core. Execute pipelines as a batch job, for example to pre-process or train your models, or perform batch inference. Serve inference requests of trained models. Deploy а trained machine learning model as a web service to serve inference requests with high performance. Register your own Docker registry, synchronize your AI content from your own git repository, and register your own object store for training data and trained models. - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -package com.sap.ai.sdk.core.model; - -import com.fasterxml.jackson.annotation.JsonAnyGetter; -import com.fasterxml.jackson.annotation.JsonAnySetter; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonValue; -import java.time.OffsetDateTime; -import java.util.LinkedHashMap; -import java.util.Map; -import java.util.NoSuchElementException; -import java.util.Objects; -import java.util.Set; -import javax.annotation.Nonnull; -import javax.annotation.Nullable; - -/** BckndEvent */ -// CHECKSTYLE:OFF -public class BckndEvent -// CHECKSTYLE:ON -{ - @JsonProperty("tenantId") - private String tenantId; - - /** Gets or Sets action */ - public enum ActionEnum { - /** The PROVISION option of this BckndEvent */ - PROVISION("PROVISION"), - - /** The DEPROVISION option of this BckndEvent */ - DEPROVISION("DEPROVISION"), - - /** The UNKNOWN_DEFAULT_OPEN_API option of this BckndEvent */ - UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api"); - - private String value; - - ActionEnum(String value) { - this.value = value; - } - - /** - * Get the value of the enum - * - * @return The enum value - */ - @JsonValue - @Nonnull - public String getValue() { - return value; - } - - /** - * Get the String value of the enum value. - * - * @return The enum value as String - */ - @Override - @Nonnull - public String toString() { - return String.valueOf(value); - } - - /** - * Get the enum value from a String value - * - * @param value The String value - * @return The enum value of type BckndEvent - */ - @JsonCreator - @Nonnull - public static ActionEnum fromValue(@Nonnull final String value) { - for (ActionEnum b : ActionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - return UNKNOWN_DEFAULT_OPEN_API; - } - } - - @JsonProperty("action") - private ActionEnum action; - - /** Gets or Sets state */ - public enum StateEnum { - /** The SUCCESSFUL option of this BckndEvent */ - SUCCESSFUL("SUCCESSFUL"), - - /** The FAILED option of this BckndEvent */ - FAILED("FAILED"), - - /** The PENDING option of this BckndEvent */ - PENDING("PENDING"), - - /** The UNKNOWN_DEFAULT_OPEN_API option of this BckndEvent */ - UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api"); - - private String value; - - StateEnum(String value) { - this.value = value; - } - - /** - * Get the value of the enum - * - * @return The enum value - */ - @JsonValue - @Nonnull - public String getValue() { - return value; - } - - /** - * Get the String value of the enum value. - * - * @return The enum value as String - */ - @Override - @Nonnull - public String toString() { - return String.valueOf(value); - } - - /** - * Get the enum value from a String value - * - * @param value The String value - * @return The enum value of type BckndEvent - */ - @JsonCreator - @Nonnull - public static StateEnum fromValue(@Nonnull final String value) { - for (StateEnum b : StateEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - return UNKNOWN_DEFAULT_OPEN_API; - } - } - - @JsonProperty("state") - private StateEnum state; - - @JsonProperty("description") - private String description; - - @JsonProperty("createdAt") - private OffsetDateTime createdAt; - - @JsonAnySetter @JsonAnyGetter - private final Map cloudSdkCustomFields = new LinkedHashMap<>(); - - /** Default constructor for BckndEvent. */ - protected BckndEvent() {} - - /** - * Set the tenantId of this {@link BckndEvent} instance and return the same instance. - * - * @param tenantId tenant id - * @return The same instance of this {@link BckndEvent} class - */ - @Nonnull - public BckndEvent tenantId(@Nullable final String tenantId) { - this.tenantId = tenantId; - return this; - } - - /** - * tenant id - * - * @return tenantId The tenantId of this {@link BckndEvent} instance. - */ - @Nonnull - public String getTenantId() { - return tenantId; - } - - /** - * Set the tenantId of this {@link BckndEvent} instance. - * - * @param tenantId tenant id - */ - public void setTenantId(@Nullable final String tenantId) { - this.tenantId = tenantId; - } - - /** - * Set the action of this {@link BckndEvent} instance and return the same instance. - * - * @param action The action of this {@link BckndEvent} - * @return The same instance of this {@link BckndEvent} class - */ - @Nonnull - public BckndEvent action(@Nullable final ActionEnum action) { - this.action = action; - return this; - } - - /** - * Get action - * - * @return action The action of this {@link BckndEvent} instance. - */ - @Nonnull - public ActionEnum getAction() { - return action; - } - - /** - * Set the action of this {@link BckndEvent} instance. - * - * @param action The action of this {@link BckndEvent} - */ - public void setAction(@Nullable final ActionEnum action) { - this.action = action; - } - - /** - * Set the state of this {@link BckndEvent} instance and return the same instance. - * - * @param state The state of this {@link BckndEvent} - * @return The same instance of this {@link BckndEvent} class - */ - @Nonnull - public BckndEvent state(@Nullable final StateEnum state) { - this.state = state; - return this; - } - - /** - * Get state - * - * @return state The state of this {@link BckndEvent} instance. - */ - @Nonnull - public StateEnum getState() { - return state; - } - - /** - * Set the state of this {@link BckndEvent} instance. - * - * @param state The state of this {@link BckndEvent} - */ - public void setState(@Nullable final StateEnum state) { - this.state = state; - } - - /** - * Set the description of this {@link BckndEvent} instance and return the same instance. - * - * @param description describes the event state - * @return The same instance of this {@link BckndEvent} class - */ - @Nonnull - public BckndEvent description(@Nullable final String description) { - this.description = description; - return this; - } - - /** - * describes the event state - * - * @return description The description of this {@link BckndEvent} instance. - */ - @Nonnull - public String getDescription() { - return description; - } - - /** - * Set the description of this {@link BckndEvent} instance. - * - * @param description describes the event state - */ - public void setDescription(@Nullable final String description) { - this.description = description; - } - - /** - * Set the createdAt of this {@link BckndEvent} instance and return the same instance. - * - * @param createdAt The createdAt of this {@link BckndEvent} - * @return The same instance of this {@link BckndEvent} class - */ - @Nonnull - public BckndEvent createdAt(@Nullable final OffsetDateTime createdAt) { - this.createdAt = createdAt; - return this; - } - - /** - * Get createdAt - * - * @return createdAt The createdAt of this {@link BckndEvent} instance. - */ - @Nonnull - public OffsetDateTime getCreatedAt() { - return createdAt; - } - - /** - * Set the createdAt of this {@link BckndEvent} instance. - * - * @param createdAt The createdAt of this {@link BckndEvent} - */ - public void setCreatedAt(@Nullable final OffsetDateTime createdAt) { - this.createdAt = createdAt; - } - - /** - * Get the names of the unrecognizable properties of the {@link BckndEvent}. - * - * @return The set of properties names - */ - @JsonIgnore - @Nonnull - public Set getCustomFieldNames() { - return cloudSdkCustomFields.keySet(); - } - - /** - * Get the value of an unrecognizable property of this {@link BckndEvent} instance. - * - * @deprecated Use {@link #toMap()} instead. - * @param name The name of the property - * @return The value of the property - * @throws NoSuchElementException If no property with the given name could be found. - */ - @Nullable - @Deprecated - public Object getCustomField(@Nonnull final String name) throws NoSuchElementException { - if (!cloudSdkCustomFields.containsKey(name)) { - throw new NoSuchElementException("BckndEvent has no field with name '" + name + "'."); - } - return cloudSdkCustomFields.get(name); - } - - /** - * Get the value of all properties of this {@link BckndEvent} instance including unrecognized - * properties. - * - * @return The map of all properties - */ - @JsonIgnore - @Nonnull - public Map toMap() { - final Map declaredFields = new LinkedHashMap<>(cloudSdkCustomFields); - if (tenantId != null) declaredFields.put("tenantId", tenantId); - if (action != null) declaredFields.put("action", action); - if (state != null) declaredFields.put("state", state); - if (description != null) declaredFields.put("description", description); - if (createdAt != null) declaredFields.put("createdAt", createdAt); - return declaredFields; - } - - /** - * Set an unrecognizable property of this {@link BckndEvent} instance. If the map previously - * contained a mapping for the key, the old value is replaced by the specified value. - * - * @param customFieldName The name of the property - * @param customFieldValue The value of the property - */ - @JsonIgnore - public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue) { - cloudSdkCustomFields.put(customFieldName, customFieldValue); - } - - @Override - public boolean equals(@Nullable final java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - final BckndEvent bckndEvent = (BckndEvent) o; - return Objects.equals(this.cloudSdkCustomFields, bckndEvent.cloudSdkCustomFields) - && Objects.equals(this.tenantId, bckndEvent.tenantId) - && Objects.equals(this.action, bckndEvent.action) - && Objects.equals(this.state, bckndEvent.state) - && Objects.equals(this.description, bckndEvent.description) - && Objects.equals(this.createdAt, bckndEvent.createdAt); - } - - @Override - public int hashCode() { - return Objects.hash(tenantId, action, state, description, createdAt, cloudSdkCustomFields); - } - - @Override - @Nonnull - public String toString() { - final StringBuilder sb = new StringBuilder(); - sb.append("class BckndEvent {\n"); - sb.append(" tenantId: ").append(toIndentedString(tenantId)).append("\n"); - sb.append(" action: ").append(toIndentedString(action)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); - cloudSdkCustomFields.forEach( - (k, v) -> - sb.append(" ").append(k).append(": ").append(toIndentedString(v)).append("\n")); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(final java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - /** Create a new {@link BckndEvent} instance. No arguments are required. */ - public static BckndEvent create() { - return new BckndEvent(); - } -} diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndInternalResourceGroup.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndInternalResourceGroup.java index 0fe8b63fa..c48d73e15 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndInternalResourceGroup.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndInternalResourceGroup.java @@ -114,6 +114,9 @@ public static StatusEnum fromValue(@Nonnull final String value) { @JsonProperty("statusMessage") private String statusMessage; + @JsonProperty("servicePlan") + private String servicePlan; + @JsonProperty("annotations") private List annotations = new ArrayList<>(); @@ -365,6 +368,38 @@ public void setStatusMessage(@Nullable final String statusMessage) { this.statusMessage = statusMessage; } + /** + * Set the servicePlan of this {@link BckndInternalResourceGroup} instance and return the same + * instance. + * + * @param servicePlan service plan + * @return The same instance of this {@link BckndInternalResourceGroup} class + */ + @Nonnull + public BckndInternalResourceGroup servicePlan(@Nullable final String servicePlan) { + this.servicePlan = servicePlan; + return this; + } + + /** + * service plan + * + * @return servicePlan The servicePlan of this {@link BckndInternalResourceGroup} instance. + */ + @Nonnull + public String getServicePlan() { + return servicePlan; + } + + /** + * Set the servicePlan of this {@link BckndInternalResourceGroup} instance. + * + * @param servicePlan service plan + */ + public void setServicePlan(@Nullable final String servicePlan) { + this.servicePlan = servicePlan; + } + /** * Set the annotations of this {@link BckndInternalResourceGroup} instance and return the same * instance. @@ -462,6 +497,7 @@ public Map toMap() { if (labels != null) declaredFields.put("labels", labels); if (status != null) declaredFields.put("status", status); if (statusMessage != null) declaredFields.put("statusMessage", statusMessage); + if (servicePlan != null) declaredFields.put("servicePlan", servicePlan); if (annotations != null) declaredFields.put("annotations", annotations); return declaredFields; } @@ -496,6 +532,7 @@ public boolean equals(@Nullable final java.lang.Object o) { && Objects.equals(this.labels, bckndInternalResourceGroup.labels) && Objects.equals(this.status, bckndInternalResourceGroup.status) && Objects.equals(this.statusMessage, bckndInternalResourceGroup.statusMessage) + && Objects.equals(this.servicePlan, bckndInternalResourceGroup.servicePlan) && Objects.equals(this.annotations, bckndInternalResourceGroup.annotations); } @@ -509,6 +546,7 @@ public int hashCode() { labels, status, statusMessage, + servicePlan, annotations, cloudSdkCustomFields); } @@ -525,6 +563,7 @@ public String toString() { sb.append(" labels: ").append(toIndentedString(labels)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" statusMessage: ").append(toIndentedString(statusMessage)).append("\n"); + sb.append(" servicePlan: ").append(toIndentedString(servicePlan)).append("\n"); sb.append(" annotations: ").append(toIndentedString(annotations)).append("\n"); cloudSdkCustomFields.forEach( (k, v) -> diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/BckndResourceGroup.java b/core/src/main/java/com/sap/ai/sdk/core/model/BckndResourceGroup.java index 392b4a57d..7b64f7729 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/BckndResourceGroup.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/BckndResourceGroup.java @@ -114,6 +114,9 @@ public static StatusEnum fromValue(@Nonnull final String value) { @JsonProperty("statusMessage") private String statusMessage; + @JsonProperty("servicePlan") + private String servicePlan; + @JsonAnySetter @JsonAnyGetter private final Map cloudSdkCustomFields = new LinkedHashMap<>(); @@ -353,6 +356,37 @@ public void setStatusMessage(@Nullable final String statusMessage) { this.statusMessage = statusMessage; } + /** + * Set the servicePlan of this {@link BckndResourceGroup} instance and return the same instance. + * + * @param servicePlan service plan + * @return The same instance of this {@link BckndResourceGroup} class + */ + @Nonnull + public BckndResourceGroup servicePlan(@Nullable final String servicePlan) { + this.servicePlan = servicePlan; + return this; + } + + /** + * service plan + * + * @return servicePlan The servicePlan of this {@link BckndResourceGroup} instance. + */ + @Nonnull + public String getServicePlan() { + return servicePlan; + } + + /** + * Set the servicePlan of this {@link BckndResourceGroup} instance. + * + * @param servicePlan service plan + */ + public void setServicePlan(@Nullable final String servicePlan) { + this.servicePlan = servicePlan; + } + /** * Get the names of the unrecognizable properties of the {@link BckndResourceGroup}. * @@ -398,6 +432,7 @@ public Map toMap() { if (labels != null) declaredFields.put("labels", labels); if (status != null) declaredFields.put("status", status); if (statusMessage != null) declaredFields.put("statusMessage", statusMessage); + if (servicePlan != null) declaredFields.put("servicePlan", servicePlan); return declaredFields; } @@ -429,7 +464,8 @@ public boolean equals(@Nullable final java.lang.Object o) { && Objects.equals(this.createdAt, bckndResourceGroup.createdAt) && Objects.equals(this.labels, bckndResourceGroup.labels) && Objects.equals(this.status, bckndResourceGroup.status) - && Objects.equals(this.statusMessage, bckndResourceGroup.statusMessage); + && Objects.equals(this.statusMessage, bckndResourceGroup.statusMessage) + && Objects.equals(this.servicePlan, bckndResourceGroup.servicePlan); } @Override @@ -442,6 +478,7 @@ public int hashCode() { labels, status, statusMessage, + servicePlan, cloudSdkCustomFields); } @@ -457,6 +494,7 @@ public String toString() { sb.append(" labels: ").append(toIndentedString(labels)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" statusMessage: ").append(toIndentedString(statusMessage)).append("\n"); + sb.append(" servicePlan: ").append(toIndentedString(servicePlan)).append("\n"); cloudSdkCustomFields.forEach( (k, v) -> sb.append(" ").append(k).append(": ").append(toIndentedString(v)).append("\n")); diff --git a/core/src/main/java/com/sap/ai/sdk/core/model/KubesubmitV4ApplicationsCreateRequest.java b/core/src/main/java/com/sap/ai/sdk/core/model/KubesubmitV4ApplicationsCreateRequest.java index 459e4835e..f8843395c 100644 --- a/core/src/main/java/com/sap/ai/sdk/core/model/KubesubmitV4ApplicationsCreateRequest.java +++ b/core/src/main/java/com/sap/ai/sdk/core/model/KubesubmitV4ApplicationsCreateRequest.java @@ -150,7 +150,7 @@ public void setPath(@Nonnull final String path) { * Set the applicationName of this {@link KubesubmitV4ApplicationsCreateRequest} instance and * return the same instance. * - * @param applicationName ArgoCD application name + * @param applicationName ArgoCD application name in the request body * @return The same instance of this {@link KubesubmitV4ApplicationsCreateRequest} class */ @Nonnull @@ -161,7 +161,7 @@ public KubesubmitV4ApplicationsCreateRequest applicationName( } /** - * ArgoCD application name + * ArgoCD application name in the request body * * @return applicationName The applicationName of this {@link * KubesubmitV4ApplicationsCreateRequest} instance. @@ -174,7 +174,7 @@ public String getApplicationName() { /** * Set the applicationName of this {@link KubesubmitV4ApplicationsCreateRequest} instance. * - * @param applicationName ArgoCD application name + * @param applicationName ArgoCD application name in the request body */ public void setApplicationName(@Nullable final String applicationName) { this.applicationName = applicationName; diff --git a/core/src/main/resources/spec/aicore.yaml b/core/src/main/resources/spec/aicore.yaml index 2e6ff3f5e..9adcf19db 100644 --- a/core/src/main/resources/spec/aicore.yaml +++ b/core/src/main/resources/spec/aicore.yaml @@ -8,7 +8,7 @@ info: with high performance. Register your own Docker registry, synchronize your AI content from your own git repository, and register your own object store for training data and trained models.\n" - version: 2.41.0 + version: 2.42.0 x-sap-shortText: Create and manage AI scenarios, trainings, deployments, and artifacts in SAP AI Core. servers: @@ -21,11 +21,17 @@ servers: - prodeuonly.eu-central-1.aws - prod.us-east-1.aws - prod.ap-northeast-1.aws + - prod-ap11.ap-southeast-1.aws + - prod-ap20.australiaeast.azure - prod.ap-southeast-2.aws - prod-eu20.westeurope.azure + - prod-ap30.australia-southeast1.gcp + - prod-in30.asia-south1.gcp + - prod-sa30.me-central2.gcp - prod-us21.eastus.azure - prod-eu30.europe-west3.gcp - prod-us30.us-central1.gcp + - prod-br10.sa-east-1.aws default: prod.eu-central-1.aws externalDocs: description: Documentation for SAP AI Core @@ -59,7 +65,7 @@ tags: description: Access to tenant information - name: Meta description: Metadata about API provider and capabilities -- name: Execution +- name: Execution Schedule description: Access to executionSchedules paths: /lm/artifacts: @@ -561,7 +567,7 @@ paths: - $ref: '#/components/parameters/AiresourceGroupHeader' get: tags: - - Execution + - Execution Schedule summary: Get list of execution schedules description: 'Retrieve a list of execution schedules that match the specified filter criteria. @@ -588,7 +594,7 @@ paths: $ref: '#/components/responses/AiBadRequest' post: tags: - - Execution + - Execution Schedule summary: Create execution schedule description: Create an execution schedule using the configuration specified by configurationId, and schedule. @@ -619,7 +625,7 @@ paths: - $ref: '#/components/parameters/AiexecutionScheduleId' get: tags: - - Execution + - Execution Schedule summary: Get information about an execution schedule description: Retrieve details for execution schedule with executionScheduleId. operationId: execution_schedule.get @@ -636,7 +642,7 @@ paths: $ref: '#/components/responses/AiNotFound' patch: tags: - - Execution + - Execution Schedule summary: Update an execution schedule description: Update details of an execution schedule operationId: execution_schedule.modify @@ -659,7 +665,7 @@ paths: $ref: '#/components/responses/AiNotFound' delete: tags: - - Execution + - Execution Schedule summary: Delete execution schedule description: Delete the execution schedule with executionScheduleId. operationId: execution_schedule.delete @@ -926,7 +932,7 @@ paths: /lm/executionSchedules/$count: get: tags: - - Execution + - Execution Schedule summary: Get number of execution schedules description: 'Retrieve the number of scheduled executions. The number can be filtered by @@ -1911,7 +1917,7 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/BckndArgoCDApplicationData' + - $ref: '#/components/schemas/BckndArgoCDApplicationDataRequest' - $ref: '#/components/schemas/BckndArgoCDApplicationDataRepoName' responses: '200': @@ -2020,7 +2026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BckndArgoCDApplicationData' + $ref: '#/components/schemas/BckndArgoCDApplicationDataResponse' '400': $ref: '#/components/responses/BckndBadRequest' '404': @@ -2448,450 +2454,320 @@ components: tokenUrl: https://{subdomain_identity_zone}.authentication.{host}/oauth/token scopes: {} schemas: - MetaCapabilities: + TrckGetMetricResource: + description: Collection of various metrics/tags/labels associated against some + execution/deployment type: object - required: - - aiApi properties: - runtimeIdentifier: - type: string - example: aicore - description: The name of the runtime - runtimeApiVersion: - $ref: '#/components/schemas/MetaVersion' - description: - type: string - aiApi: - $ref: '#/components/schemas/MetaAiApi' - extensions: - $ref: '#/components/schemas/MetaExtensions' - MetaExtensions: + executionId: + $ref: '#/components/schemas/TrckExecutionId' + createdAt: + $ref: '#/components/schemas/TrckTimestamp' + modifiedAt: + $ref: '#/components/schemas/TrckTimestamp' + metrics: + $ref: '#/components/schemas/TrckGetMetricList' + tags: + $ref: '#/components/schemas/TrckTagList' + customInfo: + $ref: '#/components/schemas/TrckCustomInfoObjectList' + required: + - executionId + TrckMetricResource: + description: Collection of various metrics/tags/labels associated against some + execution/deployment + required: + - executionId type: object properties: - analytics: - type: object - required: - - version - properties: - version: - $ref: '#/components/schemas/MetaVersion' - resourceGroups: - type: object - required: - - version - properties: - version: - $ref: '#/components/schemas/MetaVersion' - dataset: - type: object - properties: - version: - $ref: '#/components/schemas/MetaVersion' - capabilities: - description: List of Dataset extension capabilities - type: object - properties: - upload: - description: Support for uploading of files - type: boolean - default: true - download: - description: Support for downloading of files - type: boolean - default: true - delete: - description: Support for deletion of files - type: boolean - default: true - limits: - type: object - properties: - maxUploadFileSize: - type: integer - description: Max size (in bytes) of a single uploaded file allowed - by this runtime per resource group. - default: 104857600 - maxFilesPerDataset: - description: Max number of files per dataset. <0 means unlimited. - type: integer - default: -1 - acceptedContentTypes: - type: array - items: - type: string - pattern: ^\w+\/([\w+-]\.)?[\w.-]+(\+[\w-]+)*$ - required: - - version + executionId: + $ref: '#/components/schemas/TrckExecutionId' + createdAt: + $ref: '#/components/schemas/TrckTimestamp' + modifiedAt: + $ref: '#/components/schemas/TrckTimestamp' metrics: - type: object - properties: - version: - $ref: '#/components/schemas/MetaVersion' - capabilities: - description: List of Metrics extension capabilities - type: object - properties: - extendedResults: - description: Support for returning extended results - type: boolean - default: false - required: - - version - MetaAiApi: - description: There are (currently) the following types of execution engines 1) - complete runtimes that offer executions and deployments, 2) runtimes that - do only batch inference and therefore don't support deployments 3) runtimes - that allow deployments, but with predefined models and therefore don't need - executions 4) runtimes that have fixed endpoints and therefore only need listing - deployments + $ref: '#/components/schemas/TrckMetricList' + tags: + $ref: '#/components/schemas/TrckTagList' + customInfo: + $ref: '#/components/schemas/TrckCustomInfoObjectList' + TrckGetMetricResourceList: type: object - properties: - version: - $ref: '#/components/schemas/MetaVersion' - capabilities: - type: object - properties: - multitenant: - type: boolean - description: true-> AI API implementation supports resource groups (Main - Tenant scenario), false-> implementation does not support resource - groups (Service Tenant scenario) - default: true - shareable: - type: boolean - description: true-> clients can use just one instance (global static - models), false-> clients should avoid sharing an instance - default: true - staticDeployments: - type: boolean - description: There are static always running endpoints that can be used - for inference without the need to do user deployments. - default: true - userDeployments: - type: boolean - description: Services that only support batch inference typically neither - allow listing nor creation of deployments. For these, userDeployments - == false - default: true - userExecutions: - type: boolean - default: true - timeToLiveDeployments: - type: boolean - default: false - executionSchedules: - type: boolean - default: false - logs: - type: object - properties: - executions: - type: boolean - default: true - deployments: - type: boolean - default: true - bulkUpdates: - type: object - description: Services that support patch on /executions and /deployments - to change targetStatus of multiple executions and deployments. - properties: - executions: - type: boolean - default: false - deployments: - type: boolean - default: false - limits: - type: object - properties: - executions: - type: object - properties: - maxRunningCount: - description: Max nr of executions allowed by this runtime per resource - group. <0 means unlimited. - type: integer - default: -1 - deployments: - type: object - properties: - maxRunningCount: - description: Max nr of deployments allowed by this runtime per resource - group. <0 means unlimited. - type: integer - default: -1 - timeToLiveDeployments: - type: object - properties: - minimum: - type: string - default: 10m - maximum: - type: string - default: '-1' required: - - version - MetaVersion: - example: 1.2.3 - type: string - pattern: - ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ - MetaAPIVersion: - type: object + - resources properties: - versionId: - type: string - description: API version identifier - example: v1 - url: - type: string - description: URL of the API version - example: https://api.example.com/v1 - description: - type: string - description: version description - example: Example API - description: API version description - MetaApiError: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/TrckGetMetricResource' + TrckDeleteMetricsResponse: type: object - required: - - code - - message properties: - code: - type: string - description: Descriptive error code (not http status code) + id: + $ref: '#/components/schemas/TrckExecutionId' message: type: string - description: Plaintext error description - requestId: - type: string - description: ID of the individual request - target: - type: string - description: Invoked URL - details: - description: Optional details of the error message - type: object - KpiColumnName: - readOnly: true + example: Metric Resource was successfully deleted + TrckExecutionId: type: string - description: Name of the Column - anyOf: - - enum: - - ResourceGroup - - Scenario - - Executable - - Executions - - Artifacts - - Deployments - - {} - KpiArrayOfColumnNames: - uniqueItems: true - type: array - readOnly: true - items: - $ref: '#/components/schemas/KpiColumnName' - KpiAggregationAttribute: + example: aa97b177-9383-4934-8543-0f91b7a0283a + oneOf: + - $ref: '#/components/schemas/TrckMlapiExecutionId' + description: ID of the deployment/execution + TrckTimestamp: type: string - title: Aggregation Attribute - readOnly: true - KpiCountAggregate: - type: integer - title: CountAggregate - format: int64 - minimum: 0 - x-examples: {} - readOnly: true - KpiResultRow: + description: Time when the metric was created or logged in RFC3339 format + format: date-time + TrckGetMetricList: + description: Array of Metric items type: array - title: ResultRow - uniqueItems: false - x-examples: {} - description: '' items: - $ref: '#/components/schemas/KpiResultRowItem' - readOnly: true - KpiResultRowItem: - title: ResultRowItem - anyOf: - - $ref: '#/components/schemas/KpiAggregationAttribute' - - $ref: '#/components/schemas/KpiCountAggregate' - x-examples: {} - KpiResultRowList: - title: ResultRowList + $ref: '#/components/schemas/TrckGetMetric' + TrckMetricList: + description: Array of Metric items type: array items: - $ref: '#/components/schemas/KpiResultRow' - KpiResultSet: + $ref: '#/components/schemas/TrckMetric' + TrckGetMetric: + description: Key-value metrics, where the value is numeric. Metric can also + have optional step and label fields. type: object - title: ResultSet - x-examples: - example-1: - header: - - ResourceGroup - - Executions - - Artifacts - - Deployments - rows: - - - 00112233-4455-6677-8899-aabbccddeeff - - 30 - - 30 - - 3 - additionalProperties: false - minProperties: 2 - maxProperties: 2 + required: + - name + - value + - timestamp properties: - header: - $ref: '#/components/schemas/KpiArrayOfColumnNames' - rows: - $ref: '#/components/schemas/KpiResultRowList' - readOnly: true - KpiApiError: - type: object + name: + $ref: '#/components/schemas/TrckMetricName' + value: + $ref: '#/components/schemas/TrckMetricValue' + timestamp: + $ref: '#/components/schemas/TrckTimestamp' + step: + description: step is an optional integer that represents any measurement + of training progress (number of training iterations, number of epochs, + and so on) for the metric + type: integer + minimum: 0 + example: 2 + labels: + $ref: '#/components/schemas/TrckLabelList' + TrckMetric: + description: Key-value metrics, where the value is numeric. Metric can also + have optional step and label fields. required: - - code - - message + - name + - value + type: object properties: - code: - type: string - description: Descriptive error code (not http status code) - message: - type: string - description: Plaintext error description - requestId: - type: string - description: ID of the individual request - target: - type: string - description: Invoked URL - details: - description: Optional details of the error message - type: object - RTAId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Generic ID - RTATtl: + name: + $ref: '#/components/schemas/TrckMetricName' + value: + $ref: '#/components/schemas/TrckMetricValue' + timestamp: + $ref: '#/components/schemas/TrckTimestamp' + step: + description: step is an optional integer that represents any measurement + of training progress (number of training iterations, number of epochs, + and so on) for the metric + type: integer + minimum: 0 + example: 2 + labels: + $ref: '#/components/schemas/TrckLabelList' + TrckMetricName: + pattern: '[\w-]{1,64}' type: string - pattern: ^[0-9]+[m,M,h,H,d,D]$ - example: 24H - description: TTL value of deployment - RTALabelList: + maxLength: 256 + description: Name of the metric + example: Error Rate + TrckMetricValue: + type: number + description: Numeric Value of the metric + example: 0.98 + TrckmetricSelectorPermissibleValues: + description: Permissible value for $select could be either * or one or many + of the values from metrics, tags, custominfo type: array - description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/RTALabel' - RTAArtifactLabelList: + type: string + enum: + - metrics + - tags + - customInfo + - '*' + TrckLabelList: + description: a list of name-value object pairs associated with some metric. type: array - description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/RTAArtifactLabel' - RTALabel: - type: object + $ref: '#/components/schemas/TrckLabel' + example: + - name: group + value: tree-82 + - name: metrics.ai.sap.com/Artifact.name + value: sk_learn_rf_classifier_model + TrckLabel: + description: a classifying phrase/name applied to a metric required: - - key + - name - value - properties: - key: - type: string - example: ai.sap.com/scenarioName - pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*ai\.sap\.com\/[\w\.-]+$ - value: - type: string - maxLength: 5000 - RTAArtifactLabel: type: object - required: - - key - - value properties: - key: - type: string - example: ext.ai.sap.com/s4hana-version - pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ - maxLength: 256 + name: + $ref: '#/components/schemas/TrckLabelName' value: + description: Metric Label Value + maxLength: 256 + minLength: 1 type: string - maxLength: 5000 - RTACreationResponseMessage: - type: string - description: Message - example: Created - RTAScenarioId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the scenario - RTAScenario: - type: object - description: Entity having labels + example: sk_learn_random_forest_model + example: + name: group + value: tree-82 + TrckTagList: + description: a list of name-value object pairs associated with the execution/deployment. + Tags are queryable. + type: array + items: + $ref: '#/components/schemas/TrckTag' + TrckTag: + description: A dictionary of name-value pairs to support segregation at execution + level. required: - - id - name - - createdAt - - modifiedAt + - value + type: object properties: - id: - $ref: '#/components/schemas/RTAScenarioId' name: - type: string + oneOf: + - $ref: '#/components/schemas/TrckGenericName' + value: + description: tag value maxLength: 256 - description: Name of the scenario - description: - type: string - maxLength: 5000 - description: Description of the scenario - labels: - $ref: '#/components/schemas/RTALabelList' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + minLength: 1 type: string - format: date-time - description: Timestamp of latest resource modification - RTAExecutableId: + example: RFC-1 + example: + name: Artifact Group + value: RFC-1 + TrckCustomInfoObjectList: + description: '' + type: array + items: + $ref: '#/components/schemas/TrckCustomInfoObject' + TrckCustomInfoObject: + description: large object which provides rendering/semantic information regarding + certain metric for consuming application or can be complex metrics in JSON + format + required: + - name + - value + type: object + properties: + name: + oneOf: + - $ref: '#/components/schemas/TrckGenericName' + value: + $ref: '#/components/schemas/TrckCustomInfoObjectData' + example: + name: Confusion Matrix + value: '[{''Predicted'': ''False'', ''Actual'': ''False'',''value'': 34},{''Predicted'': + ''False'',''Actual'': ''True'', ''value'': 124}, {''Predicted'': ''True'',''Actual'': + ''False'',''value'': 165},{ ''Predicted'': ''True'',''Actual'': ''True'',''value'': + 36}]' + TrckCustomInfoObjectData: + description: Message + minLength: 1 type: string + example: "[{'Predicted': 'False',\t'Actual': 'False','value': 34},{'Predicted': + 'False','Actual': 'True',\t'value': 124}, {'Predicted': 'True','Actual': 'False','value': + 165},{\t'Predicted': 'True','Actual': 'True','value': 36}]" + TrckMlapiExecutionId: + description: Generic ID pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the executable - RTAExecutable: - description: Entity having labels + type: string + example: aa97b177-9383-4934-8543-0f91b7a0283a + TrckGenericName: + description: Generic name which can belong to a tag,label,metric or customInfo + Object + maxLength: 256 + minLength: 1 + type: string + example: sample name + TrckLabelName: + description: Label name to label one or more metrics. "metrics.ai.sap.com/Artifact.name" + is a reserved label to associate an artifact with the metrics + maxLength: 256 + minLength: 1 + type: string + example: metrics.ai.sap.com/Artifact.name + TrckApiError: + required: + - code + - message + type: object + properties: + code: + description: Descriptive error code (not http status code). + type: string + message: + description: plaintext error description + type: string + requestId: + description: id of individual request + type: string + target: + description: url that has been called + type: string + details: + type: array + items: + $ref: '#/components/schemas/TrckDetailsErrorResponse' + TrckDetailsErrorResponse: + type: object + properties: + code: + description: Descriptive error code (not http status code) + type: string + message: + description: Plaintext error description + type: string + TrckStringArray: + type: array + example: + - value1 + - value2 + items: + type: string + AiScenario: type: object + description: 'An ML Scenario consists of a number of executables. E.g., there + can be one or several training executables, an inference (deployment) executable. + An ML Scenario is versioned. + + ' required: - - id - name - - scenarioId - - deployable + - id - createdAt - modifiedAt properties: - id: - $ref: '#/components/schemas/RTAExecutableId' name: type: string - description: Name of the executable + maxLength: 256 + description: Name of the scenario description: type: string - description: Description of the executable - scenarioId: - $ref: '#/components/schemas/RTAScenarioId' - inputArtifacts: - $ref: '#/components/schemas/RTAExecutableInputArtifactList' - outputArtifacts: - $ref: '#/components/schemas/RTAExecutableOutputArtifactList' - parameters: - $ref: '#/components/schemas/RTAExecutableParameterList' - deployable: - type: boolean - description: Whether this pipeline is deployable - example: false + maxLength: 5000 + description: Description of the scenario labels: - $ref: '#/components/schemas/RTALabelList' + $ref: '#/components/schemas/AiScenarioLabelList' + id: + $ref: '#/components/schemas/AiScenarioId' createdAt: type: string description: Timestamp of resource creation @@ -2900,80 +2776,98 @@ components: type: string format: date-time description: Timestamp of latest resource modification - RTAExecutableParameterList: + AiScenarioLabelList: type: array - description: Executable parameters + description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/RTAExecutableParameter' - RTAExecutableParameter: + $ref: '#/components/schemas/AiScenarioLabel' + AiLabelList: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/AiLabel' + AiScenarioLabel: type: object - description: Argument of an executable required: - - name + - key + - value properties: - name: - type: string - description: Name of the signature argument - description: - type: string - maxLength: 5000 - description: Description of the signature argument - default: - type: string - description: Default value of the signature argument - type: - type: string - enum: - - string - description: Type of the signature argument - RTAExecutableInputArtifactList: - type: array - description: List of Artifacts that the executable expects as input artifacts - items: - $ref: '#/components/schemas/RTAExecutableArtifact' - RTAExecutableOutputArtifactList: - type: array - description: List of Artifacts that the executable will produce. If storage - is not managed internally, a storage location will have to be specified when - triggering an execution - items: - $ref: '#/components/schemas/RTAExecutableArtifact' - RTAExecutableArtifact: + key: + $ref: '#/components/schemas/AiScenarioLabelKey' + value: + $ref: '#/components/schemas/AiLabelValue' + AiLabel: type: object - description: Input or output artifact required: - - name + - key + - value properties: - name: - type: string - description: Name of the signature argument - description: - type: string - maxLength: 5000 - description: Description of the signature argument - kind: - type: string - description: Kind of the artifact, i.e. model or dataset - labels: - $ref: '#/components/schemas/RTAArtifactLabelList' - RTAModelBaseData: + key: + $ref: '#/components/schemas/AiLabelKey' + value: + $ref: '#/components/schemas/AiLabelValue' + AiLabelValue: + type: string + maxLength: 5000 + AiScenarioLabelKey: + type: string + example: scenarios.ai.sap.com/s4hana-version + maxLength: 256 + pattern: ^(scenarios|ext)\.ai\.sap\.com\/[\w\.-]+$ + AiLabelKey: + type: string + example: ext.ai.sap.com/s4hana-version + maxLength: 256 + pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ + AiScenarioId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the scenario + AiScenarioList: type: object + properties: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiScenario' required: - - model - - executableId - - description - - versions + - count + - resources + AiModelList: + type: object properties: - model: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiModelBaseData' + required: + - count + - resources + AiModelBaseData: + type: object + required: + - model + - executableId + - description + - versions + properties: + model: type: string description: Name of the model executableId: - $ref: '#/components/schemas/RTAExecutableId' + $ref: '#/components/schemas/AiExecutableId' description: type: string description: Description of the model and its capabilities versions: - $ref: '#/components/schemas/RTAModelVersionList' + $ref: '#/components/schemas/AiModelVersionList' displayName: type: string description: Display name of the model @@ -2985,7 +2879,7 @@ components: description: Provider of the model allowedScenarios: type: array - description: List of scenarioId:executuableId pair where the model supported + description: List of scenarioId:executableId pair where the model supported items: type: object required: @@ -2993,18 +2887,18 @@ components: - executableId properties: scenarioId: - $ref: '#/components/schemas/RTAScenarioId' + $ref: '#/components/schemas/AiScenarioId' executableId: - $ref: '#/components/schemas/RTAExecutableId' - RTAModelVersionList: + $ref: '#/components/schemas/AiExecutableId' + AiModelVersionList: type: array description: List of model versions that the model object has items: - $ref: '#/components/schemas/RTAModelVersion' - RTAModelVersion: + $ref: '#/components/schemas/AiModelVersion' + AiModelVersion: type: object description: Model version information including whether it is latest version, - its deprecation status and retirement date + its deprecation status and optional retirement date required: - name - isLatest @@ -3062,111 +2956,78 @@ components: description: List of model capabilities supported by orchestration service items: type: string - RTAArtifact: - description: Entity having labels + AiVersion: type: object required: - - name - - url - - executionId - - kind + - id - createdAt + - modifiedAt properties: - name: - type: string - maxLength: 256 - description: Name of the artifact; this is used for dependent pipelines - to resolve an artifact - executionId: - $ref: '#/components/schemas/RTAExecutionId' - url: - $ref: '#/components/schemas/RTAArtifactUrl' - signature: - $ref: '#/components/schemas/RTAArtifactSignature' - kind: - type: string - enum: - - model - - dataset - - resultset - - other - description: Kind of the artifact, i.e. model or dataset - labels: - $ref: '#/components/schemas/RTALabelList' + description: + $ref: '#/components/schemas/AiVersionDescription' + id: + $ref: '#/components/schemas/AiVersionId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' createdAt: type: string description: Timestamp of resource creation format: date-time - RTAArtifactName: - type: string - maxLength: 256 - RTAArtifactUrl: - type: string - pattern: ([a-z0-9-]+):\/\/.+ - maxLength: 1024 - example: s3://some_bucket/some_path - description: 'Reference to the location of the artifact. - - Note, the credentials will be found in a secret called - - ''some_bucket-object_store_secret''. If not provided, a default will be assumed. + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + AiVersionList: + type: object + properties: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiVersion' + required: + - count + - resources + AiExecutable: + description: 'An ML executable consists of a set of ML tasks, flows between + tasks, dependencies between tasks, models (or model versions?). ' - RTAArtifactSignature: - type: string - maxLength: 256 - RTAArtifactArray: - type: array - items: - $ref: '#/components/schemas/RTAArtifact' - RTADeployment: type: object - description: Detailed data about an inference-pipeline deployment required: - - scenarioId - - executableId + - name + - id + - versionId + - deployable - createdAt - modifiedAt properties: - scenarioId: - $ref: '#/components/schemas/RTAScenarioId' - executableId: - $ref: '#/components/schemas/RTAExecutableId' - id: - $ref: '#/components/schemas/RTADeploymentId' - deploymentUrl: - $ref: '#/components/schemas/RTADeploymentUrl' - latestRunningTargetId: - $ref: '#/components/schemas/RTALatestRunningTargetId' - targetId: - $ref: '#/components/schemas/RTATargetId' - ttl: - $ref: '#/components/schemas/RTATtl' - status: - type: string - description: Deployment status - enum: - - PENDING - - RUNNING - - COMPLETED - - DEAD - - UNKNOWN - - DELETING - statusMessage: + labels: + $ref: '#/components/schemas/AiLabelList' + name: type: string - description: Deployment status message - maxLength: 256 - lastOperation: + description: Name of the executable + description: type: string - description: Reflection of user's action on deployment. The value will be - CREATE after user sends POST - create deployment, UPDATE after user sends - PATCH - update deployment, and DELETE after user sends DELETE - delete - deployment - enum: - - CREATE - - UPDATE - - CASCADE-UPDATE - - DELETE + description: Description of the executable + id: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + versionId: + $ref: '#/components/schemas/AiVersionId' + parameters: + $ref: '#/components/schemas/AiExecutableParameterList' + inputArtifacts: + $ref: '#/components/schemas/AiExecutableArtifactList' + outputArtifacts: + $ref: '#/components/schemas/AiExecutableArtifactList' + deployable: + type: boolean + description: Whether this executable is deployable + example: false createdAt: type: string description: Timestamp of resource creation @@ -3175,139 +3036,128 @@ components: type: string format: date-time description: Timestamp of latest resource modification - RTADeploymentId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the deployment - RTATargetId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Client provided reference, with which the status of a PATCHed deployment - can be tracked - RTALatestRunningTargetId: + AiExecutableId: type: string pattern: ^[\w.-]{4,64}$ example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Target ID of the latest running deployment - RTADeploymentUrl: - description: Consumption URL of the pipeline deployment - type: string - format: url - RTADeploymentCreationResponseMessage: - type: string - description: Message - example: Deployment scheduled - RTADeploymentCascadeUpdateResponseMessage: - type: string - description: Message - example: Deployment Cascade Update scheduled - RTADeploymentDeletionResponseMessage: - type: string - description: Message - example: Deployment deletion scheduled - RTADeploymentModificationResponseMessage: - type: string - description: Message - example: Deployment modification scheduled - RTADeploymentStatusDetails: - type: object - description: Current status details of the deployment - RTADeploymentDetails: + description: ID of the executable + AiExecutableList: type: object properties: - scaling: - $ref: '#/components/schemas/RTABackendDetails' + count: + type: integer + description: Number of the resource instances in the list resources: - $ref: '#/components/schemas/RTABackendDetails' - RTABackendDetails: - type: object - properties: - backendDetails: - type: object - description: Current details of the deployment - RTAExecution: + type: array + items: + $ref: '#/components/schemas/AiExecutable' + required: + - count + - resources + AiExecutableParameter: type: object - description: Execution required: - - scenarioId - - executableId - - createdAt - - modifiedAt + - name properties: - scenarioId: - $ref: '#/components/schemas/RTAScenarioId' - executableId: - $ref: '#/components/schemas/RTAExecutableId' - id: - $ref: '#/components/schemas/RTAExecutionId' - status: + name: type: string - description: Status of the execution - enum: - - PENDING - - RUNNING - - COMPLETED - - DEAD - - STOPPING - - STOPPED - - UNKNOWN - example: COMPLETED - statusMessage: + description: Name of the executable parameter + description: type: string - description: Execution status message - maxLength: 256 - submissionTimestamp: + description: Description of the signature argument + default: type: string - description: Timestamp of execution submission - format: date-time - example: '2017-09-15T12:01:06Z' - nullable: true - startTimestamp: + description: Default value of the signature argument + type: type: string - description: Timestamp of execution start - format: date-time - example: '2017-09-15T12:01:06Z' - nullable: true - finishTimestamp: + enum: + - string + description: Type of the executable parameter + AiExecutableParameterList: + type: array + description: Executable parameters + items: + $ref: '#/components/schemas/AiExecutableParameter' + AiExecutableArtifact: + type: object + required: + - name + properties: + name: type: string - description: Timestamp of execution finish - format: date-time - example: '2017-09-15T12:01:06Z' - nullable: true + description: Name of the executable input artifacts + kind: + type: string + description: Artifact kind (model, dataset, other) + description: + type: string + description: Description of the signature argument + labels: + $ref: '#/components/schemas/AiLabelList' + AiExecutableArtifactList: + type: array + description: Executable parameters + items: + $ref: '#/components/schemas/AiExecutableArtifact' + AiConfiguration: + type: object + properties: + name: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + parameterBindings: + $ref: '#/components/schemas/AiParameterArgumentBindingList' + inputArtifactBindings: + $ref: '#/components/schemas/AiArtifactArgumentBindingList' + id: + $ref: '#/components/schemas/AiConfigurationId' createdAt: type: string description: Timestamp of resource creation format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - RTAInputArtifactArgumentBinding: - type: object + scenario: + type: object + nullable: true + anyOf: + - $ref: '#/components/schemas/AiScenario' + - {} required: - name - - url - properties: - name: - $ref: '#/components/schemas/RTAArtifactName' - url: - $ref: '#/components/schemas/RTAArtifactUrl' - signature: - $ref: '#/components/schemas/RTAArtifactSignature' - description: Required for execution - RTAOutputArtifactArgumentBinding: + - executableId + - scenarioId + - id + - createdAt + AiConfigurationBaseData: type: object required: - name + - executableId + - scenarioId properties: name: - $ref: '#/components/schemas/RTAArtifactName' - url: - $ref: '#/components/schemas/RTAArtifactUrl' - description: Result of execution - RTAExecutableArgumentBinding: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + parameterBindings: + $ref: '#/components/schemas/AiParameterArgumentBindingList' + inputArtifactBindings: + $ref: '#/components/schemas/AiArtifactArgumentBindingList' + AiConfigurationName: + type: string + pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ + maxLength: 256 + description: Name of the configuration + AiConfigurationId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the configuration + AiParameterArgumentBinding: type: object required: - key @@ -3318,192 +3168,173 @@ components: maxLength: 256 value: type: string + maxLength: 5000 description: 'Required for execution Result of activation ' - RTAExecutionId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the execution - RTAExecutionCreationResponseMessage: - type: string - description: Message - example: Execution scheduled - RTAExecutionModificationResponseMessage: - type: string - description: Message - example: Execution modification scheduled - RTAExecutionDeletionResponseMessage: - type: string - description: Message - example: Execution deletion scheduled - RTAExecutionStatusDetails: - type: object - description: Current status details of the execution - RTALogCommonResponse: + AiParameterArgumentBindingList: + type: array + maxItems: 1000 + items: + $ref: '#/components/schemas/AiParameterArgumentBinding' + AiArtifactArgumentBinding: type: object + required: + - key + - artifactId properties: - data: - $ref: '#/components/schemas/RTALogCommonData' - description: 'A common log query response. + key: + type: string + maxLength: 256 + artifactId: + $ref: '#/components/schemas/AiArtifactId' + description: 'Required for execution + + Result of activation ' - RTALogCommonData: - type: object - properties: - result: - $ref: '#/components/schemas/RTALogCommonResult' - RTALogCommonResult: + AiArtifactArgumentBindingList: type: array + maxItems: 1000 items: - $ref: '#/components/schemas/RTALogCommonResultItem' - RTALogCommonResultItem: + $ref: '#/components/schemas/AiArtifactArgumentBinding' + AiConfigurationList: type: object - description: Common log record. properties: - timestamp: - $ref: '#/components/schemas/RTAtimestamp' - msg: - $ref: '#/components/schemas/RTAmessage' - RTAtimestamp: - description: Datetime in RFC 3339. - type: string - format: date-time - example: '2021-05-19T00:00:14.347+00:00' - RTAmessage: - description: message content. - type: string - RTAErrorResponse: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiConfiguration' + required: + - count + - resources + AiConfigurationCreationResponse: type: object properties: - error: - $ref: '#/components/schemas/RTAError' - RTAError: - type: object + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiConfigurationCreationResponseMessage' required: - - code + - id - message - properties: - code: - type: string - description: Descriptive error code (not http status code) - message: - type: string - description: Plaintext error description - example: something went wrong - requestId: - type: string - description: ID of the individual request - target: - type: string - description: Invoked URL - details: - description: Optional details of the error message - type: object - DSetUrl: + AiConfigurationCreationResponseMessage: type: string - format: url - example: https://download.example.com/test/file.bin - DSetError: - description: Error Response - type: object - properties: - code: - type: string - minLength: 1 - message: - type: string - minLength: 1 - target: - type: string - minLength: 1 - requestId: - type: string - details: - type: array - uniqueItems: true - minItems: 0 - items: - required: - - code - - message - properties: - code: - type: string - minLength: 1 - message: - type: string - minLength: 1 - required: - - code - - message - x-examples: - example-1: - code: '03021655' - message: Bad request encountered. Please try again with possible-solution-here. - target: /url/path - requestId: 9832bf934f3743v3948v3 - details: - - code: '01041211' - message: Optional nested error message. - DSetFileCreationResponse: - description: Response for successful file creation + description: Message + example: Configuration created + AiDeploymentTargetStatus: + type: string + description: Status + enum: + - STOPPED + example: STOPPED + AiDeploymentStatus: + type: string + description: Deployment status + enum: + - PENDING + - RUNNING + - COMPLETED + - DEAD + - STOPPING + - STOPPED + - UNKNOWN + example: COMPLETED + AiDeploymentStatusMessage: + type: string + description: Deployment status message + maxLength: 256 + AiDeploymentStatusDetails: type: object - required: - - message - - url - properties: - message: - type: string - description: File creation response message - example: File creation acknowledged - url: - $ref: '#/components/schemas/DSetUrl' - TrckGetMetricResource: - description: Collection of various metrics/tags/labels associated against some - execution/deployment + description: Current status details of the deployment + AiExecutionStatus: + type: string + description: Execution status + enum: + - PENDING + - RUNNING + - COMPLETED + - DEAD + - STOPPING + - STOPPED + - UNKNOWN + example: COMPLETED + AiExecutionStatusMessage: + type: string + description: Execution status message + maxLength: 256 + AiExecutionStatusDetails: type: object - properties: - executionId: - $ref: '#/components/schemas/TrckExecutionId' - createdAt: - $ref: '#/components/schemas/TrckTimestamp' - modifiedAt: - $ref: '#/components/schemas/TrckTimestamp' - metrics: - $ref: '#/components/schemas/TrckGetMetricList' - tags: - $ref: '#/components/schemas/TrckTagList' - customInfo: - $ref: '#/components/schemas/TrckCustomInfoObjectList' - required: - - executionId - TrckMetricResource: - description: Collection of various metrics/tags/labels associated against some - execution/deployment - required: - - executionId + description: Current status details of the execution + AiExecution: type: object + description: Execution that may generate artifacts properties: - executionId: - $ref: '#/components/schemas/TrckExecutionId' + id: + $ref: '#/components/schemas/AiExecutionId' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + targetStatus: + type: string + description: Target status of the execution + enum: + - COMPLETED + - RUNNING + - STOPPED + - DELETED + example: STOPPED + status: + $ref: '#/components/schemas/AiExecutionStatus' + statusMessage: + $ref: '#/components/schemas/AiExecutionStatusMessage' + outputArtifacts: + $ref: '#/components/schemas/AiArtifactArray' + executionScheduleId: + $ref: '#/components/schemas/AiExecutionScheduleId' createdAt: - $ref: '#/components/schemas/TrckTimestamp' + type: string + description: Timestamp of resource creation + format: date-time modifiedAt: - $ref: '#/components/schemas/TrckTimestamp' - metrics: - $ref: '#/components/schemas/TrckMetricList' - tags: - $ref: '#/components/schemas/TrckTagList' - customInfo: - $ref: '#/components/schemas/TrckCustomInfoObjectList' - TrckGetMetricResourceList: - type: object + type: string + format: date-time + description: Timestamp of latest resource modification + submissionTime: + type: string + format: date-time + description: Timestamp of job submitted + startTime: + type: string + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: + type: string + format: date-time + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED required: - - resources + - id + - configurationId + - status + - createdAt + - modifiedAt + AiExecutionId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the execution + AiExecutionList: + type: object properties: count: type: integer @@ -3511,580 +3342,411 @@ components: resources: type: array items: - $ref: '#/components/schemas/TrckGetMetricResource' - TrckDeleteMetricsResponse: + $ref: '#/components/schemas/AiExecution' + required: + - count + - resources + AiExecutionCreationResponse: type: object properties: id: - $ref: '#/components/schemas/TrckExecutionId' + $ref: '#/components/schemas/AiId' message: - type: string - example: Metric Resource was successfully deleted - TrckExecutionId: - type: string - example: aa97b177-9383-4934-8543-0f91b7a0283a - oneOf: - - $ref: '#/components/schemas/TrckMlapiExecutionId' - description: ID of the deployment/execution - TrckTimestamp: + $ref: '#/components/schemas/AiExecutionCreationResponseMessage' + status: + $ref: '#/components/schemas/AiExecutionStatus' + required: + - id + - message + AiExecutionCreationResponseMessage: type: string - description: Time when the metric was created or logged in RFC3339 format - format: date-time - TrckGetMetricList: - description: Array of Metric items - type: array - items: - $ref: '#/components/schemas/TrckGetMetric' - TrckMetricList: - description: Array of Metric items - type: array - items: - $ref: '#/components/schemas/TrckMetric' - TrckGetMetric: - description: Key-value metrics, where the value is numeric. Metric can also - have optional step and label fields. + description: Message + example: Execution scheduled + AiExecutionModificationRequest: type: object + description: Request object for changing the target status of an execution (currently + only STOPPED is supported) required: - - name - - value - - timestamp + - targetStatus properties: - name: - $ref: '#/components/schemas/TrckMetricName' - value: - $ref: '#/components/schemas/TrckMetricValue' - timestamp: - $ref: '#/components/schemas/TrckTimestamp' - step: - description: step is an optional integer that represents any measurement - of training progress (number of training iterations, number of epochs, - and so on) for the metric - type: integer - minimum: 0 - example: 2 - labels: - $ref: '#/components/schemas/TrckLabelList' - TrckMetric: - description: Key-value metrics, where the value is numeric. Metric can also - have optional step and label fields. + targetStatus: + type: string + description: Desired target status of the execution (currently only STOPPED + is supported) + enum: + - STOPPED + AiExecutionModificationRequestWithIdentifier: required: - - name - - value + - targetStatus + - id type: object properties: - name: - $ref: '#/components/schemas/TrckMetricName' - value: - $ref: '#/components/schemas/TrckMetricValue' - timestamp: - $ref: '#/components/schemas/TrckTimestamp' - step: - description: step is an optional integer that represents any measurement - of training progress (number of training iterations, number of epochs, - and so on) for the metric - type: integer - minimum: 0 - example: 2 - labels: - $ref: '#/components/schemas/TrckLabelList' - TrckMetricName: - pattern: '[\w-]{1,64}' - type: string - maxLength: 256 - description: Name of the metric - example: Error Rate - TrckMetricValue: - type: number - description: Numeric Value of the metric - example: 0.98 - TrckmetricSelectorPermissibleValues: - description: Permissible value for $select could be either * or one or many - of the values from metrics, tags, custominfo - type: array - items: - type: string - enum: - - metrics - - tags - - customInfo - - '*' - TrckLabelList: - description: a list of name-value object pairs associated with some metric. + id: + $ref: '#/components/schemas/AiExecutionId' + targetStatus: + type: string + description: Desired target status of the execution (currently STOPPED and + DELETED are supported) + enum: + - STOPPED + - DELETED + description: Request object for changing the target status of an execution (currently + STOPPED and DELETED are supported) + AiExecutionModificationRequestList: type: array items: - $ref: '#/components/schemas/TrckLabel' + $ref: '#/components/schemas/AiExecutionModificationRequestWithIdentifier' + uniqueItems: true + minItems: 1 + maxItems: 100 example: - - name: group - value: tree-82 - - name: metrics.ai.sap.com/Artifact.name - value: sk_learn_rf_classifier_model - TrckLabel: - description: a classifying phrase/name applied to a metric - required: - - name - - value + - id: aa97b177-9383-4934-8543-0f91a7a0283a + targetStatus: STOPPED + - id: qweq32131-qwee-1231-8543-0f91a7a2e2e + targetStatus: DELETED + AiExecutionBulkModificationRequest: type: object + description: Request object to change status of multiple executions properties: - name: - $ref: '#/components/schemas/TrckLabelName' - value: - description: Metric Label Value - maxLength: 256 - minLength: 1 - type: string - example: sk_learn_random_forest_model - example: - name: group - value: tree-82 - TrckTagList: - description: a list of name-value object pairs associated with the execution/deployment. - Tags are queryable. - type: array - items: - $ref: '#/components/schemas/TrckTag' - TrckTag: - description: A dictionary of name-value pairs to support segregation at execution - level. - required: - - name - - value + executions: + $ref: '#/components/schemas/AiExecutionModificationRequestList' + AiExecutionModificationResponse: type: object properties: - name: - oneOf: - - $ref: '#/components/schemas/TrckGenericName' - value: - description: tag value - maxLength: 256 - minLength: 1 - type: string - example: RFC-1 - example: - name: Artifact Group - value: RFC-1 - TrckCustomInfoObjectList: - description: '' + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiExecutionModificationResponseMessage' + required: + - id + - message + AiExecutionModificationResponseList: type: array items: - $ref: '#/components/schemas/TrckCustomInfoObject' - TrckCustomInfoObject: - description: large object which provides rendering/semantic information regarding - certain metric for consuming application or can be complex metrics in JSON - format - required: - - name - - value + oneOf: + - $ref: '#/components/schemas/AiExecutionModificationResponse' + - $ref: '#/components/schemas/AiApiErrorWithId' + AiExecutionBulkModificationResponse: type: object + description: Response object with array of executions and its status properties: - name: - oneOf: - - $ref: '#/components/schemas/TrckGenericName' - value: - $ref: '#/components/schemas/TrckCustomInfoObjectData' - example: - name: Confusion Matrix - value: '[{''Predicted'': ''False'', ''Actual'': ''False'',''value'': 34},{''Predicted'': - ''False'',''Actual'': ''True'', ''value'': 124}, {''Predicted'': ''True'',''Actual'': - ''False'',''value'': 165},{ ''Predicted'': ''True'',''Actual'': ''True'',''value'': - 36}]' - TrckCustomInfoObjectData: - description: Message - minLength: 1 - type: string - example: "[{'Predicted': 'False',\t'Actual': 'False','value': 34},{'Predicted': - 'False','Actual': 'True',\t'value': 124}, {'Predicted': 'True','Actual': 'False','value': - 165},{\t'Predicted': 'True','Actual': 'True','value': 36}]" - TrckMlapiExecutionId: - description: Generic ID - pattern: ^[\w.-]{4,64}$ - type: string - example: aa97b177-9383-4934-8543-0f91b7a0283a - TrckGenericName: - description: Generic name which can belong to a tag,label,metric or customInfo - Object - maxLength: 256 - minLength: 1 - type: string - example: sample name - TrckLabelName: - description: Label name to label one or more metrics. "metrics.ai.sap.com/Artifact.name" - is a reserved label to associate an artifact with the metrics - maxLength: 256 - minLength: 1 - type: string - example: metrics.ai.sap.com/Artifact.name - TrckApiError: + executions: + $ref: '#/components/schemas/AiExecutionModificationResponseList' + AiExecutionDeletionResponse: + type: object + properties: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiExecutionDeletionResponseMessage' required: - - code + - id - message + AiExecutionDeletionResponseMessage: + type: string + description: Message + example: Execution deletion scheduled + AiExecutionModificationResponseMessage: + type: string + description: Message + example: Execution modification scheduled + AiExecutionResponseWithDetails: type: object + description: Execution that may generate artifacts properties: - code: - description: Descriptive error code (not http status code). + id: + $ref: '#/components/schemas/AiExecutionId' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + targetStatus: type: string - message: - description: plaintext error description + description: Target status of the execution + enum: + - COMPLETED + - RUNNING + - STOPPED + - DELETED + example: STOPPED + status: + $ref: '#/components/schemas/AiExecutionStatus' + statusMessage: + $ref: '#/components/schemas/AiExecutionStatusMessage' + outputArtifacts: + $ref: '#/components/schemas/AiArtifactArray' + executionScheduleId: + $ref: '#/components/schemas/AiExecutionScheduleId' + createdAt: type: string - requestId: - description: id of individual request + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - target: - description: url that has been called + format: date-time + description: Timestamp of latest resource modification + submissionTime: type: string - details: - type: array - items: - $ref: '#/components/schemas/TrckDetailsErrorResponse' - TrckDetailsErrorResponse: - type: object - properties: - code: - description: Descriptive error code (not http status code) + format: date-time + description: Timestamp of job submitted + startTime: type: string - message: - description: Plaintext error description - type: string - TrckStringArray: - type: array - example: - - value1 - - value2 - items: - type: string - BckndId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Generic ID - BckndMessage: - type: string - description: Message - BckndName: - type: string - description: Name - BckndCreationResponseMessage: - type: string - description: Message - example: Created - BckndUrl: - type: string - format: url - BckndResourceGroupList: - type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/BckndResourceGroup' - required: - - count - - resources - BckndResourceGroupBase: - type: object - properties: - resourceGroupId: - description: resource group id - type: string - tenantId: - description: tenant id - type: string - zoneId: - description: zone id - type: string - BckndResourceGroup: - type: object - properties: - resourceGroupId: - description: resource group id - type: string - tenantId: - description: tenant id - type: string - zoneId: - description: zone id - type: string - createdAt: - description: Timestamp of resource group creation + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: type: string format: date-time - labels: - $ref: '#/components/schemas/BckndResourceGroupLabels' - status: - description: aggregated status of the onboarding process - type: string - enum: - - PROVISIONED - - ERROR - - PROVISIONING - statusMessage: - description: status message - type: string + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED + statusDetails: + $ref: '#/components/schemas/AiExecutionStatusDetails' required: + - id + - configurationId - status - createdAt - - resourceGroupId - BckndInternalResourceGroup: + - modifiedAt + AiExecutionSchedule: type: object + description: Data about execution schedule + required: + - configurationId + - cron + - name + - createdAt + - modifiedAt properties: - resourceGroupId: - description: resource group id - type: string - tenantId: - description: tenant id + cron: + $ref: '#/components/schemas/AiCron' + name: + maxLength: 256 type: string - zoneId: - description: zone id + description: Name of the execution schedule + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + start: type: string - createdAt: - description: Timestamp of resource group creation + description: Timestamp, defining when the executions should start running + periodically, defaults to now + format: date-time + end: type: string + description: Timestamp, defining when the executions should stop running format: date-time - labels: - $ref: '#/components/schemas/BckndInternalResourceGroupLabels' + id: + $ref: '#/components/schemas/AiExecutionScheduleId' status: - description: aggregated status of the onboarding process + $ref: '#/components/schemas/AiExecutionScheduleStatus' + createdAt: type: string - enum: - - PROVISIONED - - ERROR - - PROVISIONING - statusMessage: - description: status message + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - annotations: - $ref: '#/components/schemas/BckndInternalResourceGroupAnnotations' - required: - - status - - createdAt - - resourceGroupId - BckndResourceGroupsPostRequest: + format: date-time + description: Timestamp of latest resource modification + AiExecutionScheduleId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the execution schedule + AiExecutionScheduleStatus: + type: string + description: Execution Schedule Status + enum: + - ACTIVE + - INACTIVE + example: ACTIVE + AiCron: + type: string + description: Cron defining the schedule to run the executions. + example: 0 0 0 1 * + AiExecutionScheduleCreationData: type: object + description: Start and end an execution schedule. properties: - resourceGroupId: - description: resource group id + cron: + $ref: '#/components/schemas/AiCron' + name: + maxLength: 256 type: string - pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ - minLength: 3 - maxLength: 253 - labels: - $ref: '#/components/schemas/BckndResourceGroupLabels' - BckndResourceGroupLabels: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/BckndResourceGroupLabel' - BckndResourceGroupLabel: - type: object - required: - - key - - value - properties: - key: + description: Name of the execution schedule + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + start: type: string - pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ - maxLength: 63 - example: ext.ai.sap.com/my-label - value: + description: Timestamp, defining when the executions should start running + periodically, defaults to now + format: date-time + end: type: string - maxLength: 5000 - BckndInternalResourceGroupLabels: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/BckndInternalResourceGroupLabel' - BckndInternalResourceGroupLabel: - type: object + description: Timestamp, defining when the executions should stop running + format: date-time required: - - key - - value - properties: - key: - type: string - pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ - maxLength: 63 - example: internal.ai.sap.com/my-label - value: - type: string - maxLength: 5000 - BckndInternalResourceGroupAnnotations: - type: array - description: Arbitrary annotations as meta information - items: - $ref: '#/components/schemas/BckndInternalResourceGroupAnnotation' - BckndInternalResourceGroupAnnotation: + - configurationId + - cron + - name + AiExecutionScheduleList: type: object + properties: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/AiExecutionSchedule' required: - - key - - value + - count + - resources + AiExecutionScheduleModificationRequest: + type: object + description: Request object for changing the execution schedule properties: - key: + cron: + $ref: '#/components/schemas/AiCron' + start: type: string - pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ - maxLength: 63 - example: internal.ai.sap.com/my-annotation - value: + description: Timestamp, defining when the executions should start running + periodically, defaults to now + format: date-time + end: type: string - maxLength: 5000 - BckndResourceGroupDeletionResponse: + description: Timestamp, defining when the executions should stop running + format: date-time + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + status: + $ref: '#/components/schemas/AiExecutionScheduleStatus' + AiExecutionScheduleModificationResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BckndResourceGroupDeletionResponseMessage' + $ref: '#/components/schemas/AiExecutionScheduleModificationResponseMessage' required: - id - message - BckndResourceGroupDeletionResponseMessage: + AiExecutionScheduleModificationResponseMessage: type: string description: Message - example: Resource Group deletion scheduled - BckndResourceGroupPatchRequest: + example: Execution Schedule modified + AiExecutionScheduleDeletionResponse: type: object properties: - labels: - $ref: '#/components/schemas/BckndResourceGroupLabels' - BckndEvent: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiExecutionScheduleDeletionResponseMessage' + required: + - id + - message + AiExecutionScheduleDeletionResponseMessage: + type: string + description: Message + example: Execution Schedule deleted + AiExecutionScheduleCreationResponse: type: object properties: - tenantId: - description: tenant id - type: string - action: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiExecutionScheduleCreationResponseMessage' + required: + - id + - message + AiExecutionScheduleCreationResponseMessage: + type: string + description: Message + example: Execution Schedule created + AiDeployment: + type: object + description: Detailed data about a deployment + properties: + id: + $ref: '#/components/schemas/AiDeploymentId' + deploymentUrl: + $ref: '#/components/schemas/AiDeploymentUrl' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + status: + $ref: '#/components/schemas/AiDeploymentStatus' + statusMessage: + $ref: '#/components/schemas/AiDeploymentStatusMessage' + targetStatus: type: string + description: Deployment target status enum: - - PROVISION - - DEPROVISION - state: + - RUNNING + - STOPPED + - DELETED + lastOperation: type: string - enum: - - SUCCESSFUL - - FAILED - - PENDING - description: - description: describes the event state + description: Last operation applied to this deployment. + anyOf: + - enum: + - CREATE + - UPDATE + - DELETE + - CASCADE-UPDATE + - {} + latestRunningConfigurationId: type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: configurationId that was running before a PATCH operation has + modified the configurationId of the deployment. This can be used for a + manual rollback in case the new configurationId results in a DEAD deployment + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' + details: + $ref: '#/components/schemas/AiDeploymentDetails' createdAt: type: string + description: Timestamp of resource creation format: date-time - example: '2017-09-28T08:56:23.275Z' - BckndTenant: - type: object - properties: - tenantId: - description: tenant id - type: string - zoneId: - description: zone id - type: string - realSubaccountId: - description: real sub account id - type: string - servicePlan: - description: service plan - type: string - BckndobjectStoreSecretWithSensitiveDataRequest: - type: object - description: This represents all the meta-data and extra information to be stored - as a k8-secret - required: - - name - - type - - data - properties: - name: - type: string - description: Name of the object store for the secret object to be created. - Can be used later on check for existence of the secret. - example: myobjectstore - type: - type: string - description: Storage type e.g. S3, GCS,... - example: S3 - bucket: - type: string - description: Bucket to be used - example: mybucket1 - endpoint: - type: string - description: Optional parameter - URL of the storage server (S3 only) - example: www.example.com - region: + modifiedAt: type: string - description: Optional parameter - Region of the storage server (S3 only) - example: eu - pathPrefix: + format: date-time + description: Timestamp of latest resource modification + submissionTime: type: string - description: prefix folder to be added to storage path - example: mp-api - verifyssl: + format: date-time + description: Timestamp of job submitted + startTime: type: string - description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl - example: '0' - usehttps: + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: type: string - description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps - example: '1' - default: '1' - data: - type: object - description: key:value pairs of data - writeOnly: true - BckndobjectStoreSecretWithSensitiveDataRequestForPostCall: - type: object - description: This represents all the meta-data and extra information to be stored - as a k8-secret + format: date-time + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED required: - - name - - type - - data - properties: - name: - type: string - pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ - maxLength: 233 - description: Name of the object store for the secret object to be created. - Can be used later on check for existence of the secret. - example: myobjectstore - type: - type: string - description: Storage type e.g. S3, GCS,... - example: S3 - bucket: - type: string - description: Bucket to be used - example: mybucket1 - endpoint: - type: string - description: Optional parameter - URL of the storage server (S3 only) - example: www.example.com - region: - type: string - description: Optional parameter - Region of the storage server (S3 only) - example: eu - pathPrefix: - type: string - description: prefix folder to be added to storage path - example: mp-api - verifyssl: - type: string - description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl - example: '0' - usehttps: - type: string - description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps - example: '1' - default: '1' - data: - type: object - description: key:value pairs of data - writeOnly: true - BckndobjectStoreSecretStatusResponse: - description: This represents a list of meta-data of a stored secret. The 'data' - field of the secret is never retrieved. + - id + - configurationId + - status + - createdAt + - modifiedAt + AiDeploymentId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the deployment + AiDeploymentUrl: + description: Consumption URL of the deployment + type: string + format: url + AiDeploymentList: type: object properties: count: @@ -4093,451 +3755,489 @@ components: resources: type: array items: - $ref: '#/components/schemas/BckndobjectStoreSecretStatus' + $ref: '#/components/schemas/AiDeployment' required: - count - resources - BckndobjectStoreSecretStatus: - type: object - description: This represents the meta-data of a stored secret. The 'data' field - of the secret is never retrieved. - properties: - metadata: - description: Key value pairs of meta-data assigned to the secret when the - secret was being created. - type: object - properties: - serving.kubeflow.org/s3-usehttps: - type: string - description: 0 and 1 values for setting the flag - example: '1' - serving.kubeflow.org/s3-verifyssl: - type: string - description: 0 and 1 values for setting the flag - example: '0' - serving.kubeflow.org/s3-endpoint: - type: string - description: Annotation for endpoint required by KF_Serving - example: some_endpoint - serving.kubeflow.org/s3-region: - type: string - description: Annotation for region required by KF_Serving - example: EU - storage.ai.sap.com/type: - type: string - description: Storage type of the secret - example: S3 - storage.ai.sap.com/bucket: - type: string - description: bucket assigned to the secret on creation - example: my_bucket - storage.ai.sap.com/endpoint: - type: string - description: Endpoint assigned to the secret on creation - example: some_endpoint - storage.ai.sap.com/region: - type: string - description: Region of the storage server - example: EU - storage.ai.sap.com/pathPrefix: - type: string - description: Pathprefix type assigned to the secret on creation. - example: mnist_folder - storage.ai.sap.com/hdfsNameNode: - type: string - description: name node of the HDFS file system - example: https://c3272xxxxxfa8f.files.hdl.canary-eu10.hanacloud.ondemand.com - storage.ai.sap.com/headers: - type: string - description: headers for webHDFS and other protocols - example: '{"x-sap-filecontainer": "c32727xxxxxxx322dcfa8f"}' - storage.ai.sap.com/containerUri: - type: string - description: container uri of azure storage - example: - https://sapcv842awjkfb2.blob.core.windows.net/sapcp-osaas-xxx-xxxx-xxxx-xxxx-xxxx-zrs - storage.ai.sap.com/subscriptionId: - type: string - description: subscription id - example: dgewg2-gkrwnegiw - storage.ai.sap.com/tenantId: - type: string - description: tenant id - example: dawd2120-dadwad2 - storage.ai.sap.com/projectId: - type: string - description: project id of google cloud platform - example: sap-gcp-oaas-us31-1 - name: - description: Name of objectstore - type: string - example: myobjectstore-object-store-secret - BckndobjectStoreSecretDeletionResponse: + AiDeploymentCreationResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BckndobjectStoreSecretDeletionResponseMessage' + $ref: '#/components/schemas/AiDeploymentCreationResponseMessage' + deploymentUrl: + $ref: '#/components/schemas/AiDeploymentUrl' + status: + $ref: '#/components/schemas/AiExecutionStatus' + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' required: - id - message - BckndobjectStoreSecretDeletionResponseMessage: - type: string - description: Message - example: Object Store Secret has been deleted - BckndobjectStoreSecretCreationResponse: - type: object - description: Message - example: Created - properties: - message: - $ref: '#/components/schemas/BckndobjectStoreSecretCreationResponseMessage' - BckndobjectStoreSecretCreationResponseMessage: - type: string - description: Message - example: Secret has been created - BckndobjectStoreSecretModificationResponseMessage: + AiDeploymentCreationResponseMessage: type: string description: Message - example: Secret has been modified - BckndobjectStoreSecretModificationResponse: + example: Deployment scheduled + AiEnactmentCreationRequest: type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndobjectStoreSecretModificationResponseMessage' + description: Request object for creating an execution or an deployment required: - - id - - message - BcknddockerRegistryNameComponent: - description: Name of the docker Registry store for the secret. - type: string - pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ - maxLength: 63 - example: mydockeregistry - BcknddockerRegistrySecretWithSensitiveDataRequest: + - configurationId + properties: + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + AiDeploymentCreationRequest: type: object - description: This represents all the meta-data and extra information to be stored - as a k8-secret + description: Request object for creating an execution or an deployment required: - - data + - configurationId properties: - data: - type: object - required: - - .dockerconfigjson - description: key:value pairs of data - writeOnly: true - additionalProperties: false - properties: - .dockerconfigjson: - type: string - description: .dockerconfigjson data - BcknddockerRegistrySecretStatusResponse: - description: This represents a list of meta-data of a stored secret. The 'data' - field of the secret is never retrieved. + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + AiDeploymentModificationRequest: type: object + description: Request object for changing the target status of a deployment (currently + only STOPPED is supported) properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/BcknddockerRegistrySecretStatus' - required: - - count - - resources - BcknddockerRegistrySecretStatus: + targetStatus: + $ref: '#/components/schemas/AiDeploymentTargetStatus' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + AiDeploymentModificationRequestWithIdentifier: type: object - description: This represents the meta-data of a stored secret. The 'data' field - of the secret is never retrieved. + required: + - targetStatus + - id properties: - name: - description: Name of dockerRegistryStore + id: + $ref: '#/components/schemas/AiDeploymentId' + targetStatus: type: string - example: mydockeregistry - BcknddockerRegistrySecretDeletionResponse: + description: Deployment target status + enum: + - STOPPED + - DELETED + description: Request object for changing the target status of a deployment ( + STOPPED and DELETED are supported) + AiDeploymentModificationRequestList: + type: array + items: + $ref: '#/components/schemas/AiDeploymentModificationRequestWithIdentifier' + uniqueItems: true + minItems: 1 + maxItems: 100 + example: + - id: aa97b177-9383-4934-8543-0f91a7a0283a + targetStatus: STOPPED + - id: qweq32131-qwee-1231-8543-0f91a7a2e2e + targetStatus: DELETED + AiDeploymentBulkModificationRequest: + type: object + description: Request object for changing the target status of multiple deployments + properties: + deployments: + $ref: '#/components/schemas/AiDeploymentModificationRequestList' + AiDeploymentModificationResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BcknddockerRegistrySecretDeletionResponseMessage' + $ref: '#/components/schemas/AiDeploymentModificationResponseMessage' required: - id - message - BcknddockerRegistrySecretDeletionResponseMessage: - type: string - description: Message - example: Docker Registry Secret has been deleted - BcknddockerRegistrySecretCreationResponse: + AiDeploymentModificationResponseList: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AiDeploymentModificationResponse' + - $ref: '#/components/schemas/AiApiErrorWithId' + AiDeploymentBulkModificationResponse: type: object - description: Message - example: Created + description: Response object with array of deployments properties: - message: - $ref: '#/components/schemas/BcknddockerRegistrySecretCreationResponseMessage' - BcknddockerRegistrySecretCreationResponseMessage: - type: string - description: Message - example: Secret has been created - BcknddockerRegistrySecretModificationResponseMessage: - type: string - description: Message - example: Secret has been modified - BcknddockerRegistrySecretModificationResponse: + deployments: + $ref: '#/components/schemas/AiDeploymentModificationResponseList' + AiDeploymentDeletionResponse: type: object properties: id: - $ref: '#/components/schemas/BckndId' + $ref: '#/components/schemas/AiId' message: - $ref: '#/components/schemas/BcknddockerRegistrySecretModificationResponseMessage' + $ref: '#/components/schemas/AiDeploymentDeletionResponseMessage' required: - id - message - BckndGenericSecretData: - description: Base64 encoded secret data - type: object - additionalProperties: - type: string - BckndGenericSecretPostBody: + AiDeploymentModificationResponseMessage: + type: string + description: Message + example: Deployment modification scheduled + AiDeploymentDeletionResponseMessage: + type: string + description: Message + example: Deployment deletion scheduled + AiDeploymentResponseWithDetails: type: object - required: - - name - - data + description: Detail properties of the deployment properties: - name: - description: The name of the secret + id: + $ref: '#/components/schemas/AiDeploymentId' + deploymentUrl: + $ref: '#/components/schemas/AiDeploymentUrl' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + configurationName: + $ref: '#/components/schemas/AiConfigurationName' + executableId: + $ref: '#/components/schemas/AiExecutableId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + status: + $ref: '#/components/schemas/AiDeploymentStatus' + statusMessage: + $ref: '#/components/schemas/AiDeploymentStatusMessage' + targetStatus: type: string - minLength: 1 - maxLength: 252 - pattern: ^[a-z0-9\-\.]+$ - data: - $ref: '#/components/schemas/BckndGenericSecretData' - labels: - $ref: '#/components/schemas/BckndGenericSecretLabels' - BckndGenericSecretPatchBody: - type: object - required: - - data - properties: - data: - $ref: '#/components/schemas/BckndGenericSecretData' - labels: - $ref: '#/components/schemas/BckndGenericSecretLabels' - BckndGenericSecretDataResponse: - type: object - properties: - message: - $ref: '#/components/schemas/BckndMessage' - name: - $ref: '#/components/schemas/BckndName' - BckndGenericSecretDetails: - type: object - required: - - name - - createdAt - properties: - name: - description: Name of the secret - type: string - createdAt: - description: Timestamp at which secret was created + description: Deployment target status + enum: + - RUNNING + - STOPPED + - DELETED + lastOperation: type: string - labels: - $ref: '#/components/schemas/BckndGenericSecretLabels' - resourceGroupSecretsSyncStatus: - description: Sync status of the replicated secrets in all resource groups - of the tenant - type: object - additionalProperties: - type: boolean - description: Resource group ID and sync status - BckndListGenericSecretsResponse: - description: This represents a list of meta-data of the secret. The 'data' field - of the secret is never retrieved. - type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/BckndGenericSecretDetails' - required: - - count - - resources - BckndGenericSecretLabels: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/BckndGenericSecretLabel' - BckndGenericSecretLabel: - type: object - required: - - key - - value - properties: - key: + description: Last operation applied to this deployment. + anyOf: + - enum: + - CREATE + - UPDATE + - DELETE + - CASCADE-UPDATE + - {} + latestRunningConfigurationId: type: string - pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ - maxLength: 63 - example: ext.ai.sap.com/my-label - value: + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: configurationId that was running before a PATCH operation has + modified the configurationId of the deployment. This can be used for a + manual rollback in case the new configurationId results in a DEAD deployment + ttl: + $ref: '#/components/schemas/AiDeploymentTimeToLive' + details: + $ref: '#/components/schemas/AiDeploymentDetails' + createdAt: type: string - maxLength: 5000 - BckndArgoCDRepositoryData: - type: object - required: - - url - - username - - password - properties: - name: - description: Name of the repository + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - minLength: 1 - maxLength: 51 - pattern: ^[a-z0-9\-]+$ - url: - description: URL of the repository to synchronise + format: date-time + description: Timestamp of latest resource modification + submissionTime: type: string - username: - description: Username for read-access to the repository + format: date-time + description: Timestamp of job submitted + startTime: type: string - password: - description: Password for read-access to the repository + format: date-time + description: Timestamp of job status changed to RUNNING + completionTime: type: string - BckndArgoCDRepositoryCredentials: - type: object + format: date-time + description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED + statusDetails: + $ref: '#/components/schemas/AiDeploymentStatusDetails' required: - - username - - password + - id + - configurationId + - status + - createdAt + - modifiedAt + AiBackendDetails: + type: object + description: backend-specific details of the deployment + AiScalingDetails: + type: object + description: Scaling details of a deployment + example: + backendDetails: + predictor: + minReplicas: 0 + maxReplicas: 2 + runningReplicas: 1 properties: - username: - description: Username for read-access to the repository - type: string - password: - description: Password for read-access to the repository - type: string - BckndArgoCDRepositoryDataResponse: - description: This represents a list of GitOps repositories for the tenant. + backendDetails: + $ref: '#/components/schemas/AiBackendDetails' + AiResourcesDetails: type: object + description: Resources details of a deployment + example: + backendDetails: + predictor: + resourcePlan: starter properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/BckndArgoCDRepositoryDetails' - required: - - count - - resources - BckndArgoCDRepositoryCreationResponse: + backendDetails: + $ref: '#/components/schemas/AiBackendDetails' + AiDeploymentDetails: type: object + description: 'Detail information about a deployment (including predefined sections: + `scaling` and `resources`). + + JSON String representation of this object is limited to 5000 characters + + ' properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDRepositoryCreationResponseMessage' - required: - - id - - message - BckndArgoCDRepositoryCreationResponseMessage: + scaling: + $ref: '#/components/schemas/AiScalingDetails' + resources: + $ref: '#/components/schemas/AiResourcesDetails' + AiDeploymentTimeToLive: type: string - description: Message - example: Repository has been on-boarded - BckndArgoCDRepositoryDetails: + description: Time to live for a deployment. Its value can be either null or + a number followed by the unit (any of following values, minutes(m|M), hours(h|H) + or days(d|D)) + nullable: true + pattern: ^[0-9]+[m,M,h,H,d,D]$ + example: 24H + AiArtifact: + description: 'Base data of the artifact; this is the data that can be provided + when the artifact is created; `name` and `kind` are required because they + constitute important semantic filtering criteria for use in training / inference + executables (`name` is a semantic handle of the artifact within a scenario + and `kind` specifies the type of usage, e.g. you would only want to allow + models in the model operator). + + ' type: object - description: Repository details properties: + labels: + $ref: '#/components/schemas/AiLabelList' name: - description: The name of the repository + $ref: '#/components/schemas/AiArtifactName' + kind: type: string + enum: + - model + - dataset + - resultset + - other + description: Kind of the artifact, i.e. model or dataset url: - description: The repository URL + $ref: '#/components/schemas/AiArtifactUrl' + description: + $ref: '#/components/schemas/AiArtifactDescription' + id: + $ref: '#/components/schemas/AiArtifactId' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + configurationId: + $ref: '#/components/schemas/AiConfigurationId' + executionId: + $ref: '#/components/schemas/AiExecutionId' + createdAt: type: string - status: - description: The status of the repository's on-boarding + description: Timestamp of resource creation + format: date-time + modifiedAt: type: string - enum: - - ERROR - - IN-PROGRESS - - COMPLETED - example: COMPLETED - BckndArgoCDRepositoryDeletionResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDRepositoryDeletionResponseMessage' - required: - - id - - message - BckndArgoCDRepositoryDeletionResponseMessage: + format: date-time + description: Timestamp of latest resource modification + scenario: + type: object + nullable: true + anyOf: + - $ref: '#/components/schemas/AiScenario' + - {} + required: + - name + - kind + - url + - id + - scenarioId + - createdAt + - modifiedAt + AiArtifactDescription: type: string - description: Message - example: The repository has been off-boarded. - BckndArgoCDRepositoryModificationResponse: + maxLength: 5000 + description: Description of the artifact + AiArtifactPostData: type: object + description: 'Base data of the artifact; this is the data that can be provided + when the artifact is created; `name` and `kind` are required because they + constitute important semantic filtering criteria for use in training / inference + executables (`name` is a semantic handle of the artifact within a scenario + and `kind` specifies the type of usage, e.g. you would only want to allow + models in the model operator). + + ' + required: + - name + - kind + - url + - scenarioId properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDRepositoryModificationResponseMessage' + labels: + $ref: '#/components/schemas/AiLabelList' + name: + $ref: '#/components/schemas/AiArtifactName' + kind: + type: string + enum: + - model + - dataset + - resultset + - other + description: Kind of the artifact, i.e. model or dataset + url: + $ref: '#/components/schemas/AiArtifactUrl' + description: + $ref: '#/components/schemas/AiArtifactDescription' + scenarioId: + $ref: '#/components/schemas/AiScenarioId' + AiArtifactCreationResponse: + type: object required: - id - message - BckndArgoCDRepositoryModificationResponseMessage: + - url + properties: + id: + $ref: '#/components/schemas/AiId' + message: + $ref: '#/components/schemas/AiArtifactCreationResponseMessage' + url: + $ref: '#/components/schemas/AiArtifactUrl' + AiArtifactCreationResponseMessage: type: string description: Message - example: ArgoCD application has been updated - BckndArgoCDApplicationBaseData: + example: Artifact acknowledged + AiArtifactId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the artifact + AiArtifactName: + type: string + pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ + maxLength: 256 + description: Name of the artifact + AiArtifactUrl: + type: string + pattern: ([a-z0-9-]+):\/\/.+ + maxLength: 1024 + example: https://example.com/some_path + description: 'Reference to the location of the artifact. + + ' + AiArtifactList: type: object + properties: + count: + type: integer + description: Number of the resource instances in the list + resources: + $ref: '#/components/schemas/AiArtifactArray' required: - - repositoryUrl - - revision - - path + - count + - resources + AiArtifactArray: + type: array + items: + $ref: '#/components/schemas/AiArtifact' + AiLogCommonData: + type: object properties: - repositoryUrl: - description: URL of the repository to synchronise - type: string - revision: - description: revision to synchronise + result: + $ref: '#/components/schemas/AiLogCommonResult' + AiLogCommonResult: + type: array + items: + $ref: '#/components/schemas/AiLogCommonResultItem' + AiLogCommonResultItem: + type: object + description: Common log record. + properties: + timestamp: + description: Datetime in RFC 3339. type: string - path: - description: path within the repository to synchronise + format: date-time + example: '2021-05-19T00:00:14.347+00:00' + msg: + description: message content. type: string - BckndArgoCDApplicationData: + AiId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: Generic ID + AiVersionId: + description: Version ID + type: string + AiVersionDescription: + type: string + maxLength: 5000 + example: This is version v1 + description: Version description + AiCreationResponseMessage: + type: string + description: Message + example: Created + AiUrl: + type: string + format: url + AiApiErrorWithId: type: object + required: + - id + - error properties: - repositoryUrl: - description: URL of the repository to synchronise + id: + $ref: '#/components/schemas/AiId' + error: + $ref: '#/components/schemas/AiApiError' + AiApiError: + type: object + required: + - code + - message + properties: + code: type: string - revision: - description: revision to synchronise + description: Descriptive error code (not http status code) + message: type: string - path: - description: path within the repository to synchronise + description: Plaintext error description + requestId: type: string - applicationName: - description: ArgoCD application name + description: ID of the individual request + target: type: string - minLength: 3 - maxLength: 54 - pattern: ^[a-z0-9\-]+$ - required: - - repositoryUrl - - revision - - path - BckndAllArgoCDApplicationData: - description: list of applications + description: Invoked URL + details: + description: Optional details of the error message + type: object + BckndId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: Generic ID + BckndMessage: + type: string + description: Message + BckndName: + type: string + description: Name + BckndCreationResponseMessage: + type: string + description: Message + example: Created + BckndUrl: + type: string + format: url + BckndResourceGroupList: type: object properties: count: @@ -4546,692 +4246,636 @@ components: resources: type: array items: - $ref: '#/components/schemas/BckndArgoCDApplicationData' + $ref: '#/components/schemas/BckndResourceGroup' required: - count - resources - BckndArgoCDApplicationDataRepoName: + BckndResourceGroupBase: type: object - required: - - repositoryName - - revision - - path properties: - repositoryName: - description: Name of the repository to synchronise - type: string - revision: - description: revision to synchronise + resourceGroupId: + description: resource group id type: string - path: - description: path within the repository to synchronise + tenantId: + description: tenant id type: string - applicationName: - description: ArgoCD application name + zoneId: + description: zone id type: string - minLength: 3 - maxLength: 54 - pattern: ^[a-z0-9\-]+$ - BckndArgoCDApplicationStatus: + BckndResourceGroup: type: object - description: ArgoCD application definition and status properties: - healthStatus: - description: ArgoCD application health status + resourceGroupId: + description: resource group id type: string - syncStatus: - description: ArgoCD application sync status + tenantId: + description: tenant id type: string - message: - description: ArgoCD application health status message + zoneId: + description: zone id type: string - source: - description: Information about the ArgoCD application itself - type: object - properties: - repoURL: - description: URL of the repository - type: string - path: - description: Path of the repository - type: string - revision: - description: Revision number of the ArgoCD application - type: string - syncFinishedAt: - description: Gets the timestamp information related to the sync state of - the ArgoCD application - type: string - syncStartedAt: - description: Get timestamp information related to the sync state of the - ArgoCD application - type: string - reconciledAt: - description: Get timestamp information related to the sync state of the - ArgoCD application - type: string - syncResourcesStatus: - description: Status of all resources that need to be synchronized with the - gitops repo - type: array - items: - type: object - properties: - name: - description: ArgoCD application object name - type: string - kind: - description: ArgoCD application object kind - type: string - status: - description: ArgoCD application object sync status - type: string - message: - description: ArgoCD application object message - type: string - syncRessourcesStatus: - deprecated: true - description: Status of all resources that need to be synchronized with the - gitops repo. Misspelled and deprecated, use syncResourcesStatus instead. - type: array - items: - type: object - properties: - name: - description: ArgoCD application object name - type: string - kind: - description: ArgoCD application object kind - type: string - status: - description: ArgoCD application object sync status - type: string - message: - description: ArgoCD application object message - type: string - BckndArgoCDApplicationDeletionResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDApplicationDeletionResponseMessage' - required: - - id - - message - BckndArgoCDApplicationDeletionResponseMessage: - type: string - description: Message - example: ArgoCD application has been deleted - BckndArgoCDApplicationCreationResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDApplicationCreationResponseMessage' - required: - - id - - message - BckndArgoCDApplicationCreationResponseMessage: - type: string - description: Message - example: ArgoCD application has been created - BckndArgoCDApplicationModificationResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDApplicationModificationResponseMessage' - required: - - id - - message - BckndArgoCDApplicationModificationResponseMessage: - type: string - description: Message - example: ArgoCD application has been updated - BckndArgoCDApplicationRefreshResponse: - type: object - properties: - id: - $ref: '#/components/schemas/BckndId' - message: - $ref: '#/components/schemas/BckndArgoCDApplicationRefreshResponseMessage' - required: - - id - - message - BckndArgoCDApplicationRefreshResponseMessage: - type: string - description: Message - example: Refresh of ArgoCD application has been scheduled - BckndServiceList: - type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/BckndService' - required: - - count - - resources - BckndService: - type: object - properties: - name: - description: service name - type: string - description: - description: service description - type: string - url: - description: service broker url + createdAt: + description: Timestamp of resource group creation type: string + format: date-time + labels: + $ref: '#/components/schemas/BckndResourceGroupLabels' status: - description: aggregated status of the service + description: aggregated status of the onboarding process type: string enum: - PROVISIONED - ERROR - PROVISIONING - - DEPROVISIONING statusMessage: description: status message type: string - BckndExtendedService: + servicePlan: + description: service plan + type: string + required: + - status + - createdAt + - resourceGroupId + BckndInternalResourceGroup: type: object properties: - name: - description: service name + resourceGroupId: + description: resource group id type: string - description: - description: service description + tenantId: + description: tenant id type: string - url: - description: service broker url + zoneId: + description: zone id type: string - brokerSecret: - $ref: '#/components/schemas/BckndServiceBrokerSecret' - capabilities: - $ref: '#/components/schemas/BckndServiceCapabilities' - serviceCatalog: - $ref: '#/components/schemas/BckndServiceServiceCatalog' - sharedResourceGroupStatus: - $ref: '#/components/schemas/BckndSharedResourceGroupStatus' + createdAt: + description: Timestamp of resource group creation + type: string + format: date-time + labels: + $ref: '#/components/schemas/BckndInternalResourceGroupLabels' status: - description: aggregated status of the service + description: aggregated status of the onboarding process type: string enum: - PROVISIONED - ERROR - PROVISIONING - - DEPROVISIONING statusMessage: description: status message type: string - BckndServiceBrokerSecret: + servicePlan: + description: service plan + type: string + annotations: + $ref: '#/components/schemas/BckndInternalResourceGroupAnnotations' + required: + - status + - createdAt + - resourceGroupId + BckndResourceGroupsPostRequest: type: object properties: - name: - description: broker secret name + resourceGroupId: + description: resource group id type: string - passwordKeyRef: - description: username key reference in broker secret + pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ + minLength: 3 + maxLength: 253 + labels: + $ref: '#/components/schemas/BckndResourceGroupLabels' + BckndResourceGroupLabels: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/BckndResourceGroupLabel' + BckndResourceGroupLabel: + type: object + required: + - key + - value + properties: + key: type: string - usernameKeyRef: - description: password key reference in broker secret + pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ + maxLength: 63 + example: ext.ai.sap.com/my-label + value: type: string - BckndServiceCapabilities: + maxLength: 5000 + BckndInternalResourceGroupLabels: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/BckndInternalResourceGroupLabel' + BckndInternalResourceGroupLabel: type: object + required: + - key + - value properties: - logs: - description: Capabilities to read logs from deployments and executions. - type: object - properties: - deployments: - type: boolean - executions: - type: boolean - basic: - description: Basic capabilities like creating deployments and executions. - type: object - properties: - staticDeployments: - description: There are static always running endpoints that can be used - for inference without the need to do user deployments. - type: boolean - userDeployments: - description: Services that only support batch inference typically neither - allow listing nor creation of deployments. For these, userDeployments - == false - type: boolean - createExecutions: - description: Services that only support deployment typically neither - allow create executions. For these, createExecutions == false - type: boolean - userPromptTemplates: - description: Services that only support create, read and delete of prompt - templates - type: boolean - multitenant: - description: true-> AI API implementation supports resource groups (Main - Tenant scenario), false-> implementation does not support resource - groups (Service Tenant scenario) - type: boolean - BckndServiceServiceCatalog: + key: + type: string + pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ + maxLength: 63 + example: internal.ai.sap.com/my-label + value: + type: string + maxLength: 5000 + BckndInternalResourceGroupAnnotations: type: array + description: Arbitrary annotations as meta information items: - $ref: '#/components/schemas/BckndServiceServiceCatalogItem' - BckndServiceServiceCatalogItem: - type: object - properties: - extendCatalog: - $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCatalog' - extendCredentials: - $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCredentials' - BckndServiceServiceCatalogItemExtendCatalog: + $ref: '#/components/schemas/BckndInternalResourceGroupAnnotation' + BckndInternalResourceGroupAnnotation: type: object + required: + - key + - value properties: - bindable: - description: if the service is bindable - type: boolean - description: - description: description of the service - type: string - id: - description: id of the service + key: type: string - name: - description: name of the service + pattern: ^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$ + maxLength: 63 + example: internal.ai.sap.com/my-annotation + value: type: string - plans: - type: array - items: - $ref: '#/components/schemas/BckndServiceServicePlanItem' - BckndServiceServicePlanItem: + maxLength: 5000 + BckndResourceGroupDeletionResponse: type: object properties: - description: - description: description of the service plan - type: string - free: - description: if the service plan free - type: boolean id: - description: id of the service plan - type: string - name: - description: name of the service plan - type: string - metadata: - $ref: '#/components/schemas/BckndServiceServicePlanItemMetadata' - BckndServiceServicePlanItemMetadata: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndResourceGroupDeletionResponseMessage' + required: + - id + - message + BckndResourceGroupDeletionResponseMessage: + type: string + description: Message + example: Resource Group deletion scheduled + BckndResourceGroupPatchRequest: type: object properties: - supportedPlatforms: - description: supported platforms of the service plan - type: array - items: - type: string - enum: - - cloudfoundry - - kubernetes - - sapbtp - BckndServiceServiceCatalogItemExtendCredentials: + labels: + $ref: '#/components/schemas/BckndResourceGroupLabels' + BckndTenant: type: object properties: - shared: - type: object - properties: - serviceUrls: - type: object - properties: - AI_API_URL: - type: string - BckndSharedResourceGroupStatus: + tenantId: + description: tenant id + type: string + zoneId: + description: zone id + type: string + realSubaccountId: + description: real sub account id + type: string + servicePlan: + description: service plan + type: string + BckndobjectStoreSecretWithSensitiveDataRequest: type: object + description: This represents all the meta-data and extra information to be stored + as a k8-secret + required: + - name + - type + - data properties: - isEnabled: - description: indicates whether shared resource group is enabled - type: boolean - id: - description: shared resource group id + name: type: string - state: - description: current state of shared resource group + description: Name of the object store for the secret object to be created. + Can be used later on check for existence of the secret. + example: myobjectstore + type: type: string - BckndDeploymentResourceQuotaResponse: + description: Storage type e.g. S3, GCS,... + example: S3 + bucket: + type: string + description: Bucket to be used + example: mybucket1 + endpoint: + type: string + description: Optional parameter - URL of the storage server (S3 only) + example: www.example.com + region: + type: string + description: Optional parameter - Region of the storage server (S3 only) + example: eu + pathPrefix: + type: string + description: prefix folder to be added to storage path + example: mp-api + verifyssl: + type: string + description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl + example: '0' + usehttps: + type: string + description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps + example: '1' + default: '1' + data: + type: object + description: key:value pairs of data + writeOnly: true + BckndobjectStoreSecretWithSensitiveDataRequestForPostCall: type: object + description: This represents all the meta-data and extra information to be stored + as a k8-secret required: - - quotas + - name + - type + - data properties: - usage: - $ref: '#/components/schemas/BckndDeploymentUsage' - quotas: - type: array - items: - $ref: '#/components/schemas/BckndDeploymentQuotaItem' - BckndDeploymentUsage: + name: + type: string + pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ + maxLength: 233 + description: Name of the object store for the secret object to be created. + Can be used later on check for existence of the secret. + example: myobjectstore + type: + type: string + description: Storage type e.g. S3, GCS,... + example: S3 + bucket: + type: string + description: Bucket to be used + example: mybucket1 + endpoint: + type: string + description: Optional parameter - URL of the storage server (S3 only) + example: www.example.com + region: + type: string + description: Optional parameter - Region of the storage server (S3 only) + example: eu + pathPrefix: + type: string + description: prefix folder to be added to storage path + example: mp-api + verifyssl: + type: string + description: 0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl + example: '0' + usehttps: + type: string + description: 0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps + example: '1' + default: '1' + data: + type: object + description: key:value pairs of data + writeOnly: true + BckndobjectStoreSecretStatusResponse: + description: This represents a list of meta-data of a stored secret. The 'data' + field of the secret is never retrieved. type: object - required: - - count - - items properties: count: type: integer - items: + description: Number of the resource instances in the list + resources: type: array items: - $ref: '#/components/schemas/BckndUsageResourcePlanItem' - BckndUsageResourcePlanItem: - type: object + $ref: '#/components/schemas/BckndobjectStoreSecretStatus' required: - - id - properties: - id: - type: string - resourcePlanType: - type: string - configuredMaxReplicas: - type: integer - BckndDeploymentQuotaItem: + - count + - resources + BckndobjectStoreSecretStatus: type: object + description: This represents the meta-data of a stored secret. The 'data' field + of the secret is never retrieved. properties: - resourcePlanType: - type: string - deploymentQuota: - $ref: '#/components/schemas/BckndDeploymentQuota' - BckndDeploymentQuota: + metadata: + description: Key value pairs of meta-data assigned to the secret when the + secret was being created. + type: object + properties: + serving.kubeflow.org/s3-usehttps: + type: string + description: 0 and 1 values for setting the flag + example: '1' + serving.kubeflow.org/s3-verifyssl: + type: string + description: 0 and 1 values for setting the flag + example: '0' + serving.kubeflow.org/s3-endpoint: + type: string + description: Annotation for endpoint required by KF_Serving + example: some_endpoint + serving.kubeflow.org/s3-region: + type: string + description: Annotation for region required by KF_Serving + example: EU + storage.ai.sap.com/type: + type: string + description: Storage type of the secret + example: S3 + storage.ai.sap.com/bucket: + type: string + description: bucket assigned to the secret on creation + example: my_bucket + storage.ai.sap.com/endpoint: + type: string + description: Endpoint assigned to the secret on creation + example: some_endpoint + storage.ai.sap.com/region: + type: string + description: Region of the storage server + example: EU + storage.ai.sap.com/pathPrefix: + type: string + description: Pathprefix type assigned to the secret on creation. + example: mnist_folder + storage.ai.sap.com/hdfsNameNode: + type: string + description: name node of the HDFS file system + example: https://c3272xxxxxfa8f.files.hdl.canary-eu10.hanacloud.ondemand.com + storage.ai.sap.com/headers: + type: string + description: headers for webHDFS and other protocols + example: '{"x-sap-filecontainer": "c32727xxxxxxx322dcfa8f"}' + storage.ai.sap.com/containerUri: + type: string + description: container uri of azure storage + example: + https://sapcv842awjkfb2.blob.core.windows.net/sapcp-osaas-xxx-xxxx-xxxx-xxxx-xxxx-zrs + storage.ai.sap.com/subscriptionId: + type: string + description: subscription id + example: dgewg2-gkrwnegiw + storage.ai.sap.com/tenantId: + type: string + description: tenant id + example: dawd2120-dadwad2 + storage.ai.sap.com/projectId: + type: string + description: project id of google cloud platform + example: sap-gcp-oaas-us31-1 + name: + description: Name of objectstore + type: string + example: myobjectstore-object-store-secret + BckndobjectStoreSecretDeletionResponse: type: object properties: - maxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - maxReplicaPerDeployment: - type: integer - BckndCommonResourceQuotaResponse: - type: object + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndobjectStoreSecretDeletionResponseMessage' required: - - quota + - id + - message + BckndobjectStoreSecretDeletionResponseMessage: + type: string + description: Message + example: Object Store Secret has been deleted + BckndobjectStoreSecretCreationResponse: + type: object + description: Message + example: Created properties: - usage: - type: object - properties: - count: - type: integer - quota: - type: object - properties: - maxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - BckndExecutableResourceQuotaResponse: + message: + $ref: '#/components/schemas/BckndobjectStoreSecretCreationResponseMessage' + BckndobjectStoreSecretCreationResponseMessage: + type: string + description: Message + example: Secret has been created + BckndobjectStoreSecretModificationResponseMessage: + type: string + description: Message + example: Secret has been modified + BckndobjectStoreSecretModificationResponse: type: object + properties: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndobjectStoreSecretModificationResponseMessage' required: - - quota + - id + - message + BcknddockerRegistryNameComponent: + description: Name of the docker Registry store for the secret. + type: string + pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ + maxLength: 63 + example: mydockeregistry + BcknddockerRegistrySecretWithSensitiveDataRequest: + type: object + description: This represents all the meta-data and extra information to be stored + as a k8-secret + required: + - data properties: - usage: - type: object - properties: - servingTemplateCount: - type: integer - workflowTemplateCount: - type: integer - quota: + data: type: object + required: + - .dockerconfigjson + description: key:value pairs of data + writeOnly: true + additionalProperties: false properties: - servingTemplateMaxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - workflowTemplateMaxCount: - type: integer - description: The value can be 0(disabled) or a positive integer defining - the maximum allowed number - example: 10 - BckndResourcePatchBody: + .dockerconfigjson: + type: string + description: .dockerconfigjson data + BcknddockerRegistrySecretStatusResponse: + description: This represents a list of meta-data of a stored secret. The 'data' + field of the secret is never retrieved. type: object - required: - - resourcePlans properties: - resourcePlans: - $ref: '#/components/schemas/BckndResourcePatchResourcePlans' - BckndResourcePatchResourcePlans: - type: array - items: - $ref: '#/components/schemas/BckndResourcePatchNodes' - BckndResourcePatchNodes: - type: object + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/BcknddockerRegistrySecretStatus' required: - - name - - request + - count + - resources + BcknddockerRegistrySecretStatus: + type: object + description: This represents the meta-data of a stored secret. The 'data' field + of the secret is never retrieved. properties: name: + description: Name of dockerRegistryStore type: string - request: - type: integer - BckndResourcePatchResponse: + example: mydockeregistry + BcknddockerRegistrySecretDeletionResponse: type: object + properties: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BcknddockerRegistrySecretDeletionResponseMessage' required: + - id - message + BcknddockerRegistrySecretDeletionResponseMessage: + type: string + description: Message + example: Docker Registry Secret has been deleted + BcknddockerRegistrySecretCreationResponse: + type: object + description: Message + example: Created properties: message: - type: string - BckndResourceGetResponse: + $ref: '#/components/schemas/BcknddockerRegistrySecretCreationResponseMessage' + BcknddockerRegistrySecretCreationResponseMessage: + type: string + description: Message + example: Secret has been created + BcknddockerRegistrySecretModificationResponseMessage: + type: string + description: Message + example: Secret has been modified + BcknddockerRegistrySecretModificationResponse: type: object - required: - - resourcePlans properties: - resourcePlans: - $ref: '#/components/schemas/BckndResourceGetResourcePlans' - BckndInstanceTypeGetResponse: - type: object + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BcknddockerRegistrySecretModificationResponseMessage' required: - - instanceTypes - properties: - instanceTypes: - $ref: '#/components/schemas/BckndInstanceType' - BckndResourceGetResourcePlans: + - id + - message + BckndGenericSecretData: + description: Base64 encoded secret data type: object additionalProperties: - type: object - required: - - provisioned - - requested - properties: - provisioned: - type: integer - requested: - type: integer - BckndInstanceType: - type: object - additionalProperties: - type: object - required: - - memory - - cpu - - gpu - - billableUnitsPerHour - properties: - memory: - type: string - description: Memory allocated for the instance type (e.g., "16Gi") - cpu: - type: number - description: Number of CPU cores allocated for the instance type - gpu: - type: number - description: Number of GPUs allocated for the instance type - billableUnitsPerHour: - type: number - description: Number of billable units per hour for the instance type - BckndErrorResponse: - type: object - properties: - error: - $ref: '#/components/schemas/BckndError' - BckndError: + type: string + BckndGenericSecretPostBody: type: object required: - - code - - message + - name + - data properties: - code: - type: string - description: Descriptive error code (not http status code) - message: - type: string - description: Plaintext error description - example: something went wrong - requestId: - type: string - description: ID of the individual request - target: + name: + description: The name of the secret type: string - description: Invoked URL - details: - description: Optional details of the error message - type: object - TntTenantInfo: + minLength: 1 + maxLength: 252 + pattern: ^[a-z0-9\-\.]+$ + data: + $ref: '#/components/schemas/BckndGenericSecretData' + labels: + $ref: '#/components/schemas/BckndGenericSecretLabels' + BckndGenericSecretPatchBody: type: object required: - - tenantId - - servicePlan - - status + - data properties: - tenantId: - description: tenant id - type: string - example: aa97b177-9383-4934-8543-0f91a7a0283a - servicePlan: - type: string - status: - description: Provisioning status of the tenant - type: string - TntApiError: + data: + $ref: '#/components/schemas/BckndGenericSecretData' + labels: + $ref: '#/components/schemas/BckndGenericSecretLabels' + BckndGenericSecretDataResponse: type: object - required: - - code - - message properties: - code: - type: string - description: Descriptive error code (not http status code) message: - type: string - description: Plaintext error description - requestId: - type: string - description: ID of the individual request - target: - type: string - description: Invoked URL - details: - description: Optional details of the error message - type: object - AiScenario: + $ref: '#/components/schemas/BckndMessage' + name: + $ref: '#/components/schemas/BckndName' + BckndGenericSecretDetails: type: object - description: 'An ML Scenario consists of a number of executables. E.g., there - can be one or several training executables, an inference (deployment) executable. - An ML Scenario is versioned. - - ' required: - name - - id - createdAt - - modifiedAt properties: name: + description: Name of the secret type: string - maxLength: 256 - description: Name of the scenario - description: - type: string - maxLength: 5000 - description: Description of the scenario - labels: - $ref: '#/components/schemas/AiScenarioLabelList' - id: - $ref: '#/components/schemas/AiScenarioId' createdAt: + description: Timestamp at which secret was created type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - AiScenarioLabelList: - type: array - description: Arbitrary labels as meta information - items: - $ref: '#/components/schemas/AiScenarioLabel' - AiLabelList: + labels: + $ref: '#/components/schemas/BckndGenericSecretLabels' + resourceGroupSecretsSyncStatus: + description: Sync status of the replicated secrets in all resource groups + of the tenant + type: object + additionalProperties: + type: boolean + description: Resource group ID and sync status + BckndListGenericSecretsResponse: + description: This represents a list of meta-data of the secret. The 'data' field + of the secret is never retrieved. + type: object + properties: + count: + type: integer + description: Number of the resource instances in the list + resources: + type: array + items: + $ref: '#/components/schemas/BckndGenericSecretDetails' + required: + - count + - resources + BckndGenericSecretLabels: type: array description: Arbitrary labels as meta information items: - $ref: '#/components/schemas/AiLabel' - AiScenarioLabel: + $ref: '#/components/schemas/BckndGenericSecretLabel' + BckndGenericSecretLabel: type: object required: - key - value properties: key: - $ref: '#/components/schemas/AiScenarioLabelKey' + type: string + pattern: ^ext.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,48}$ + maxLength: 63 + example: ext.ai.sap.com/my-label value: - $ref: '#/components/schemas/AiLabelValue' - AiLabel: + type: string + maxLength: 5000 + BckndArgoCDRepositoryData: type: object required: - - key - - value + - url + - username + - password properties: - key: - $ref: '#/components/schemas/AiLabelKey' - value: - $ref: '#/components/schemas/AiLabelValue' - AiLabelValue: - type: string - maxLength: 5000 - AiScenarioLabelKey: - type: string - example: scenarios.ai.sap.com/s4hana-version - maxLength: 256 - pattern: ^(scenarios|ext)\.ai\.sap\.com\/[\w\.-]+$ - AiLabelKey: - type: string - example: ext.ai.sap.com/s4hana-version - maxLength: 256 - pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ - AiScenarioId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the scenario - AiScenarioList: + name: + description: Name of the repository + type: string + minLength: 1 + maxLength: 51 + pattern: ^[a-z0-9\-]+$ + url: + description: URL of the repository to synchronise + type: string + username: + description: Username for read-access to the repository + type: string + password: + description: Password for read-access to the repository + type: string + BckndArgoCDRepositoryCredentials: type: object - properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiScenario' required: - - count - - resources - AiModelList: + - username + - password + properties: + username: + description: Username for read-access to the repository + type: string + password: + description: Password for read-access to the repository + type: string + BckndArgoCDRepositoryDataResponse: + description: This represents a list of GitOps repositories for the tenant. type: object properties: count: @@ -5240,202 +4884,132 @@ components: resources: type: array items: - $ref: '#/components/schemas/AiModelBaseData' + $ref: '#/components/schemas/BckndArgoCDRepositoryDetails' required: - count - resources - AiModelBaseData: + BckndArgoCDRepositoryCreationResponse: type: object - required: - - model - - executableId - - description - - versions properties: - model: - type: string - description: Name of the model - executableId: - $ref: '#/components/schemas/AiExecutableId' - description: - type: string - description: Description of the model and its capabilities - versions: - $ref: '#/components/schemas/AiModelVersionList' - displayName: - type: string - description: Display name of the model - accessType: - type: string - description: Access type of the model - provider: - type: string - description: Provider of the model - allowedScenarios: - type: array - description: List of scenarioId:executableId pair where the model supported - items: - type: object - required: - - scenarioId - - executableId - properties: - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - executableId: - $ref: '#/components/schemas/AiExecutableId' - AiModelVersionList: - type: array - description: List of model versions that the model object has - items: - $ref: '#/components/schemas/AiModelVersion' - AiModelVersion: - type: object - description: Model version information including whether it is latest version, - its deprecation status and optional retirement date + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDRepositoryCreationResponseMessage' required: - - name - - isLatest - - deprecated + - id + - message + BckndArgoCDRepositoryCreationResponseMessage: + type: string + description: Message + example: Repository has been on-boarded + BckndArgoCDRepositoryDetails: + type: object + description: Repository details properties: name: + description: The name of the repository type: string - description: Name of model version - isLatest: - type: boolean - description: Displays whether it is the latest version offered for the model - deprecated: - type: boolean - description: Deprecation status of model - retirementDate: + url: + description: The repository URL type: string - description: Retirement date of model in ISO 8601 timestamp - contextLength: - type: integer - description: Context length of the model - inputTypes: - type: array - description: List of input types supported by the model - items: - type: string - capabilities: - type: array - description: List of capabilities supported by the model - items: - type: string - metadata: - type: array - description: List of metadata supported by the model - items: - type: object - additionalProperties: - type: string - cost: - type: array - description: List of costs associated with the model - items: - type: object - additionalProperties: - type: string - suggestedReplacements: - type: array - description: List of suggested replacements for the model - items: - type: string - streamingSupported: - type: boolean - description: Streaming support status of the model - orchestrationCapabilities: - type: array - description: List of model capabilities supported by orchestration service - items: - type: string - AiVersion: + status: + description: The status of the repository's on-boarding + type: string + enum: + - ERROR + - IN-PROGRESS + - COMPLETED + example: COMPLETED + BckndArgoCDRepositoryDeletionResponse: type: object + properties: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDRepositoryDeletionResponseMessage' required: - id - - createdAt - - modifiedAt + - message + BckndArgoCDRepositoryDeletionResponseMessage: + type: string + description: Message + example: The repository has been off-boarded. + BckndArgoCDRepositoryModificationResponse: + type: object properties: - description: - $ref: '#/components/schemas/AiVersionDescription' id: - $ref: '#/components/schemas/AiVersionId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - createdAt: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDRepositoryModificationResponseMessage' + required: + - id + - message + BckndArgoCDRepositoryModificationResponseMessage: + type: string + description: Message + example: ArgoCD application has been updated + BckndArgoCDApplicationBaseData: + type: object + required: + - repositoryUrl + - revision + - path + properties: + repositoryUrl: + description: URL of the repository to synchronise type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + revision: + description: revision to synchronise type: string - format: date-time - description: Timestamp of latest resource modification - AiVersionList: + path: + description: path within the repository to synchronise + type: string + BckndArgoCDApplicationDataRequest: type: object properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiVersion' + repositoryUrl: + description: URL of the repository to synchronise + type: string + revision: + description: revision to synchronise + type: string + path: + description: path within the repository to synchronise + type: string + applicationName: + description: ArgoCD application name in the request body + type: string + minLength: 3 + maxLength: 54 + pattern: ^[a-z0-9\-]+$ required: - - count - - resources - AiExecutable: - description: 'An ML executable consists of a set of ML tasks, flows between - tasks, dependencies between tasks, models (or model versions?). - - ' + - repositoryUrl + - revision + - path + BckndArgoCDApplicationDataResponse: type: object - required: - - name - - id - - versionId - - deployable - - createdAt - - modifiedAt properties: - labels: - $ref: '#/components/schemas/AiLabelList' - name: + repositoryUrl: + description: URL of the repository to synchronise type: string - description: Name of the executable - description: + revision: + description: revision to synchronise type: string - description: Description of the executable - id: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - versionId: - $ref: '#/components/schemas/AiVersionId' - parameters: - $ref: '#/components/schemas/AiExecutableParameterList' - inputArtifacts: - $ref: '#/components/schemas/AiExecutableArtifactList' - outputArtifacts: - $ref: '#/components/schemas/AiExecutableArtifactList' - deployable: - type: boolean - description: Whether this executable is deployable - example: false - createdAt: + path: + description: path within the repository to synchronise type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + applicationName: + description: ArgoCD application name in the response body type: string - format: date-time - description: Timestamp of latest resource modification - AiExecutableId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the executable - AiExecutableList: + minLength: 3 + maxLength: 63 + pattern: ^[a-z0-9\-]+$ + required: + - repositoryUrl + - revision + - path + BckndAllArgoCDApplicationData: + description: list of applications type: object properties: count: @@ -5444,157 +5018,166 @@ components: resources: type: array items: - $ref: '#/components/schemas/AiExecutable' + $ref: '#/components/schemas/BckndArgoCDApplicationDataResponse' required: - count - resources - AiExecutableParameter: + BckndArgoCDApplicationDataRepoName: type: object required: - - name + - repositoryName + - revision + - path properties: - name: + repositoryName: + description: Name of the repository to synchronise type: string - description: Name of the executable parameter - description: + revision: + description: revision to synchronise type: string - description: Description of the signature argument - default: + path: + description: path within the repository to synchronise type: string - description: Default value of the signature argument - type: + applicationName: + description: ArgoCD application name in the request body type: string - enum: - - string - description: Type of the executable parameter - AiExecutableParameterList: - type: array - description: Executable parameters - items: - $ref: '#/components/schemas/AiExecutableParameter' - AiExecutableArtifact: + minLength: 3 + maxLength: 54 + pattern: ^[a-z0-9\-]+$ + BckndArgoCDApplicationStatus: type: object - required: - - name + description: ArgoCD application definition and status properties: - name: + healthStatus: + description: ArgoCD application health status type: string - description: Name of the executable input artifacts - kind: + syncStatus: + description: ArgoCD application sync status type: string - description: Artifact kind (model, dataset, other) - description: + message: + description: ArgoCD application health status message type: string - description: Description of the signature argument - labels: - $ref: '#/components/schemas/AiLabelList' - AiExecutableArtifactList: - type: array - description: Executable parameters - items: - $ref: '#/components/schemas/AiExecutableArtifact' - AiConfiguration: + source: + description: Information about the ArgoCD application itself + type: object + properties: + repoURL: + description: URL of the repository + type: string + path: + description: Path of the repository + type: string + revision: + description: Revision number of the ArgoCD application + type: string + syncFinishedAt: + description: Gets the timestamp information related to the sync state of + the ArgoCD application + type: string + syncStartedAt: + description: Get timestamp information related to the sync state of the + ArgoCD application + type: string + reconciledAt: + description: Get timestamp information related to the sync state of the + ArgoCD application + type: string + syncResourcesStatus: + description: Status of all resources that need to be synchronized with the + gitops repo + type: array + items: + type: object + properties: + name: + description: ArgoCD application object name + type: string + kind: + description: ArgoCD application object kind + type: string + status: + description: ArgoCD application object sync status + type: string + message: + description: ArgoCD application object message + type: string + syncRessourcesStatus: + deprecated: true + description: Status of all resources that need to be synchronized with the + gitops repo. Misspelled and deprecated, use syncResourcesStatus instead. + type: array + items: + type: object + properties: + name: + description: ArgoCD application object name + type: string + kind: + description: ArgoCD application object kind + type: string + status: + description: ArgoCD application object sync status + type: string + message: + description: ArgoCD application object message + type: string + BckndArgoCDApplicationDeletionResponse: type: object properties: - name: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - parameterBindings: - $ref: '#/components/schemas/AiParameterArgumentBindingList' - inputArtifactBindings: - $ref: '#/components/schemas/AiArtifactArgumentBindingList' id: - $ref: '#/components/schemas/AiConfigurationId' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - scenario: - type: object - nullable: true - anyOf: - - $ref: '#/components/schemas/AiScenario' - - {} + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDApplicationDeletionResponseMessage' required: - - name - - executableId - - scenarioId - id - - createdAt - AiConfigurationBaseData: + - message + BckndArgoCDApplicationDeletionResponseMessage: + type: string + description: Message + example: ArgoCD application has been deleted + BckndArgoCDApplicationCreationResponse: type: object - required: - - name - - executableId - - scenarioId properties: - name: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - parameterBindings: - $ref: '#/components/schemas/AiParameterArgumentBindingList' - inputArtifactBindings: - $ref: '#/components/schemas/AiArtifactArgumentBindingList' - AiConfigurationName: - type: string - pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ - maxLength: 256 - description: Name of the configuration - AiConfigurationId: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDApplicationCreationResponseMessage' + required: + - id + - message + BckndArgoCDApplicationCreationResponseMessage: type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the configuration - AiParameterArgumentBinding: + description: Message + example: ArgoCD application has been created + BckndArgoCDApplicationModificationResponse: type: object - required: - - key - - value properties: - key: - type: string - maxLength: 256 - value: - type: string - maxLength: 5000 - description: 'Required for execution - - Result of activation - - ' - AiParameterArgumentBindingList: - type: array - maxItems: 1000 - items: - $ref: '#/components/schemas/AiParameterArgumentBinding' - AiArtifactArgumentBinding: - type: object + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDApplicationModificationResponseMessage' required: - - key - - artifactId + - id + - message + BckndArgoCDApplicationModificationResponseMessage: + type: string + description: Message + example: ArgoCD application has been updated + BckndArgoCDApplicationRefreshResponse: + type: object properties: - key: - type: string - maxLength: 256 - artifactId: - $ref: '#/components/schemas/AiArtifactId' - description: 'Required for execution - - Result of activation - - ' - AiArtifactArgumentBindingList: - type: array - maxItems: 1000 - items: - $ref: '#/components/schemas/AiArtifactArgumentBinding' - AiConfigurationList: + id: + $ref: '#/components/schemas/BckndId' + message: + $ref: '#/components/schemas/BckndArgoCDApplicationRefreshResponseMessage' + required: + - id + - message + BckndArgoCDApplicationRefreshResponseMessage: + type: string + description: Message + example: Refresh of ArgoCD application has been scheduled + BckndServiceList: type: object properties: count: @@ -5603,834 +5186,623 @@ components: resources: type: array items: - $ref: '#/components/schemas/AiConfiguration' + $ref: '#/components/schemas/BckndService' required: - count - resources - AiConfigurationCreationResponse: + BckndService: type: object properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiConfigurationCreationResponseMessage' - required: - - id - - message - AiConfigurationCreationResponseMessage: - type: string - description: Message - example: Configuration created - AiDeploymentTargetStatus: - type: string - description: Status - enum: - - STOPPED - example: STOPPED - AiDeploymentStatus: - type: string - description: Deployment status - enum: - - PENDING - - RUNNING - - COMPLETED - - DEAD - - STOPPING - - STOPPED - - UNKNOWN - example: COMPLETED - AiDeploymentStatusMessage: - type: string - description: Deployment status message - maxLength: 256 - AiDeploymentStatusDetails: - type: object - description: Current status details of the deployment - AiExecutionStatus: - type: string - description: Execution status - enum: - - PENDING - - RUNNING - - COMPLETED - - DEAD - - STOPPING - - STOPPED - - UNKNOWN - example: COMPLETED - AiExecutionStatusMessage: - type: string - description: Execution status message - maxLength: 256 - AiExecutionStatusDetails: - type: object - description: Current status details of the execution - AiExecution: - type: object - description: Execution that may generate artifacts - properties: - id: - $ref: '#/components/schemas/AiExecutionId' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - targetStatus: + name: + description: service name + type: string + description: + description: service description + type: string + url: + description: service broker url type: string - description: Target status of the execution - enum: - - COMPLETED - - RUNNING - - STOPPED - - DELETED - example: STOPPED status: - $ref: '#/components/schemas/AiExecutionStatus' + description: aggregated status of the service + type: string + enum: + - PROVISIONED + - ERROR + - PROVISIONING + - DEPROVISIONING statusMessage: - $ref: '#/components/schemas/AiExecutionStatusMessage' - outputArtifacts: - $ref: '#/components/schemas/AiArtifactArray' - executionScheduleId: - $ref: '#/components/schemas/AiExecutionScheduleId' - createdAt: + description: status message type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + BckndExtendedService: + type: object + properties: + name: + description: service name type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: + description: + description: service description type: string - format: date-time - description: Timestamp of job submitted - startTime: + url: + description: service broker url type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: + brokerSecret: + $ref: '#/components/schemas/BckndServiceBrokerSecret' + capabilities: + $ref: '#/components/schemas/BckndServiceCapabilities' + serviceCatalog: + $ref: '#/components/schemas/BckndServiceServiceCatalog' + sharedResourceGroupStatus: + $ref: '#/components/schemas/BckndSharedResourceGroupStatus' + status: + description: aggregated status of the service type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED - required: - - id - - configurationId - - status - - createdAt - - modifiedAt - AiExecutionId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the execution - AiExecutionList: + enum: + - PROVISIONED + - ERROR + - PROVISIONING + - DEPROVISIONING + statusMessage: + description: status message + type: string + BckndServiceBrokerSecret: type: object properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiExecution' - required: - - count - - resources - AiExecutionCreationResponse: + name: + description: broker secret name + type: string + passwordKeyRef: + description: username key reference in broker secret + type: string + usernameKeyRef: + description: password key reference in broker secret + type: string + BckndServiceCapabilities: type: object properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionCreationResponseMessage' - status: - $ref: '#/components/schemas/AiExecutionStatus' - required: - - id - - message - AiExecutionCreationResponseMessage: - type: string - description: Message - example: Execution scheduled - AiExecutionModificationRequest: + logs: + description: Capabilities to read logs from deployments and executions. + type: object + properties: + deployments: + type: boolean + executions: + type: boolean + basic: + description: Basic capabilities like creating deployments and executions. + type: object + properties: + staticDeployments: + description: There are static always running endpoints that can be used + for inference without the need to do user deployments. + type: boolean + userDeployments: + description: Services that only support batch inference typically neither + allow listing nor creation of deployments. For these, userDeployments + == false + type: boolean + createExecutions: + description: Services that only support deployment typically neither + allow create executions. For these, createExecutions == false + type: boolean + userPromptTemplates: + description: Services that only support create, read and delete of prompt + templates + type: boolean + multitenant: + description: true-> AI API implementation supports resource groups (Main + Tenant scenario), false-> implementation does not support resource + groups (Service Tenant scenario) + type: boolean + BckndServiceServiceCatalog: + type: array + items: + $ref: '#/components/schemas/BckndServiceServiceCatalogItem' + BckndServiceServiceCatalogItem: type: object - description: Request object for changing the target status of an execution (currently - only STOPPED is supported) - required: - - targetStatus properties: - targetStatus: - type: string - description: Desired target status of the execution (currently only STOPPED - is supported) - enum: - - STOPPED - AiExecutionModificationRequestWithIdentifier: - required: - - targetStatus - - id + extendCatalog: + $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCatalog' + extendCredentials: + $ref: '#/components/schemas/BckndServiceServiceCatalogItemExtendCredentials' + BckndServiceServiceCatalogItemExtendCatalog: type: object properties: + bindable: + description: if the service is bindable + type: boolean + description: + description: description of the service + type: string id: - $ref: '#/components/schemas/AiExecutionId' - targetStatus: + description: id of the service type: string - description: Desired target status of the execution (currently STOPPED and - DELETED are supported) - enum: - - STOPPED - - DELETED - description: Request object for changing the target status of an execution (currently - STOPPED and DELETED are supported) - AiExecutionModificationRequestList: - type: array - items: - $ref: '#/components/schemas/AiExecutionModificationRequestWithIdentifier' - uniqueItems: true - minItems: 1 - maxItems: 100 - example: - - id: aa97b177-9383-4934-8543-0f91a7a0283a - targetStatus: STOPPED - - id: qweq32131-qwee-1231-8543-0f91a7a2e2e - targetStatus: DELETED - AiExecutionBulkModificationRequest: - type: object - description: Request object to change status of multiple executions - properties: - executions: - $ref: '#/components/schemas/AiExecutionModificationRequestList' - AiExecutionModificationResponse: + name: + description: name of the service + type: string + plans: + type: array + items: + $ref: '#/components/schemas/BckndServiceServicePlanItem' + BckndServiceServicePlanItem: type: object properties: + description: + description: description of the service plan + type: string + free: + description: if the service plan free + type: boolean id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionModificationResponseMessage' - required: - - id - - message - AiExecutionModificationResponseList: - type: array - items: - oneOf: - - $ref: '#/components/schemas/AiExecutionModificationResponse' - - $ref: '#/components/schemas/AiApiErrorWithId' - AiExecutionBulkModificationResponse: + description: id of the service plan + type: string + name: + description: name of the service plan + type: string + metadata: + $ref: '#/components/schemas/BckndServiceServicePlanItemMetadata' + BckndServiceServicePlanItemMetadata: type: object - description: Response object with array of executions and its status properties: - executions: - $ref: '#/components/schemas/AiExecutionModificationResponseList' - AiExecutionDeletionResponse: + supportedPlatforms: + description: supported platforms of the service plan + type: array + items: + type: string + enum: + - cloudfoundry + - kubernetes + - sapbtp + BckndServiceServiceCatalogItemExtendCredentials: type: object properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionDeletionResponseMessage' - required: - - id - - message - AiExecutionDeletionResponseMessage: - type: string - description: Message - example: Execution deletion scheduled - AiExecutionModificationResponseMessage: - type: string - description: Message - example: Execution modification scheduled - AiExecutionResponseWithDetails: + shared: + type: object + properties: + serviceUrls: + type: object + properties: + AI_API_URL: + type: string + BckndSharedResourceGroupStatus: type: object - description: Execution that may generate artifacts properties: + isEnabled: + description: indicates whether shared resource group is enabled + type: boolean id: - $ref: '#/components/schemas/AiExecutionId' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - targetStatus: - type: string - description: Target status of the execution - enum: - - COMPLETED - - RUNNING - - STOPPED - - DELETED - example: STOPPED - status: - $ref: '#/components/schemas/AiExecutionStatus' - statusMessage: - $ref: '#/components/schemas/AiExecutionStatusMessage' - outputArtifacts: - $ref: '#/components/schemas/AiArtifactArray' - executionScheduleId: - $ref: '#/components/schemas/AiExecutionScheduleId' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: - type: string - format: date-time - description: Timestamp of job submitted - startTime: + description: shared resource group id type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: + state: + description: current state of shared resource group type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED - statusDetails: - $ref: '#/components/schemas/AiExecutionStatusDetails' - required: - - id - - configurationId - - status - - createdAt - - modifiedAt - AiExecutionSchedule: + BckndDeploymentResourceQuotaResponse: type: object - description: Data about execution schedule required: - - configurationId - - cron - - name - - createdAt - - modifiedAt + - quotas properties: - cron: - $ref: '#/components/schemas/AiCron' - name: - maxLength: 256 - type: string - description: Name of the execution schedule - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - start: - type: string - description: Timestamp, defining when the executions should start running - periodically, defaults to now - format: date-time - end: - type: string - description: Timestamp, defining when the executions should stop running - format: date-time - id: - $ref: '#/components/schemas/AiExecutionScheduleId' - status: - $ref: '#/components/schemas/AiExecutionScheduleStatus' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - AiExecutionScheduleId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the execution schedule - AiExecutionScheduleStatus: - type: string - description: Execution Schedule Status - enum: - - ACTIVE - - INACTIVE - example: ACTIVE - AiCron: - type: string - description: Cron defining the schedule to run the executions. - example: 0 0 0 1 * - AiExecutionScheduleCreationData: + usage: + $ref: '#/components/schemas/BckndDeploymentUsage' + quotas: + type: array + items: + $ref: '#/components/schemas/BckndDeploymentQuotaItem' + BckndDeploymentUsage: type: object - description: Start and end an execution schedule. - properties: - cron: - $ref: '#/components/schemas/AiCron' - name: - maxLength: 256 - type: string - description: Name of the execution schedule - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - start: - type: string - description: Timestamp, defining when the executions should start running - periodically, defaults to now - format: date-time - end: - type: string - description: Timestamp, defining when the executions should stop running - format: date-time required: - - configurationId - - cron - - name - AiExecutionScheduleList: - type: object + - count + - items properties: count: type: integer - description: Number of the resource instances in the list - resources: + items: type: array items: - $ref: '#/components/schemas/AiExecutionSchedule' - required: - - count - - resources - AiExecutionScheduleModificationRequest: + $ref: '#/components/schemas/BckndUsageResourcePlanItem' + BckndUsageResourcePlanItem: type: object - description: Request object for changing the execution schedule + required: + - id properties: - cron: - $ref: '#/components/schemas/AiCron' - start: + id: type: string - description: Timestamp, defining when the executions should start running - periodically, defaults to now - format: date-time - end: + resourcePlanType: type: string - description: Timestamp, defining when the executions should stop running - format: date-time - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - status: - $ref: '#/components/schemas/AiExecutionScheduleStatus' - AiExecutionScheduleModificationResponse: + configuredMaxReplicas: + type: integer + BckndDeploymentQuotaItem: type: object properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionScheduleModificationResponseMessage' - required: - - id - - message - AiExecutionScheduleModificationResponseMessage: - type: string - description: Message - example: Execution Schedule modified - AiExecutionScheduleDeletionResponse: + resourcePlanType: + type: string + deploymentQuota: + $ref: '#/components/schemas/BckndDeploymentQuota' + BckndDeploymentQuota: type: object properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionScheduleDeletionResponseMessage' - required: - - id - - message - AiExecutionScheduleDeletionResponseMessage: - type: string - description: Message - example: Execution Schedule deleted - AiExecutionScheduleCreationResponse: + maxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + maxReplicaPerDeployment: + type: integer + BckndCommonResourceQuotaResponse: type: object - properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiExecutionScheduleCreationResponseMessage' required: - - id - - message - AiExecutionScheduleCreationResponseMessage: - type: string - description: Message - example: Execution Schedule created - AiDeployment: + - quota + properties: + usage: + type: object + properties: + count: + type: integer + quota: + type: object + properties: + maxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + BckndExecutableResourceQuotaResponse: type: object - description: Detailed data about a deployment + required: + - quota properties: - id: - $ref: '#/components/schemas/AiDeploymentId' - deploymentUrl: - $ref: '#/components/schemas/AiDeploymentUrl' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - status: - $ref: '#/components/schemas/AiDeploymentStatus' - statusMessage: - $ref: '#/components/schemas/AiDeploymentStatusMessage' - targetStatus: - type: string - description: Deployment target status - enum: - - RUNNING - - STOPPED - - DELETED - lastOperation: - type: string - description: Last operation applied to this deployment. - anyOf: - - enum: - - CREATE - - UPDATE - - DELETE - - CASCADE-UPDATE - - {} - latestRunningConfigurationId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: configurationId that was running before a PATCH operation has - modified the configurationId of the deployment. This can be used for a - manual rollback in case the new configurationId results in a DEAD deployment - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' - details: - $ref: '#/components/schemas/AiDeploymentDetails' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: - type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: - type: string - format: date-time - description: Timestamp of job submitted - startTime: - type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: - type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED + usage: + type: object + properties: + servingTemplateCount: + type: integer + workflowTemplateCount: + type: integer + quota: + type: object + properties: + servingTemplateMaxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + workflowTemplateMaxCount: + type: integer + description: The value can be 0(disabled) or a positive integer defining + the maximum allowed number + example: 10 + BckndResourcePatchBody: + type: object required: - - id - - configurationId - - status - - createdAt - - modifiedAt - AiDeploymentId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the deployment - AiDeploymentUrl: - description: Consumption URL of the deployment - type: string - format: url - AiDeploymentList: + - resourcePlans + properties: + resourcePlans: + $ref: '#/components/schemas/BckndResourcePatchResourcePlans' + BckndResourcePatchResourcePlans: + type: array + items: + $ref: '#/components/schemas/BckndResourcePatchNodes' + BckndResourcePatchNodes: type: object + required: + - name + - request properties: - count: + name: + type: string + request: type: integer - description: Number of the resource instances in the list - resources: - type: array - items: - $ref: '#/components/schemas/AiDeployment' - required: - - count - - resources - AiDeploymentCreationResponse: + BckndResourcePatchResponse: type: object - properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiDeploymentCreationResponseMessage' - deploymentUrl: - $ref: '#/components/schemas/AiDeploymentUrl' - status: - $ref: '#/components/schemas/AiExecutionStatus' - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' required: - - id - message - AiDeploymentCreationResponseMessage: - type: string - description: Message - example: Deployment scheduled - AiEnactmentCreationRequest: + properties: + message: + type: string + BckndResourceGetResponse: type: object - description: Request object for creating an execution or an deployment required: - - configurationId + - resourcePlans properties: - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - AiDeploymentCreationRequest: + resourcePlans: + $ref: '#/components/schemas/BckndResourceGetResourcePlans' + BckndInstanceTypeGetResponse: type: object - description: Request object for creating an execution or an deployment required: - - configurationId + - instanceTypes properties: - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - AiDeploymentModificationRequest: + instanceTypes: + $ref: '#/components/schemas/BckndInstanceType' + BckndResourceGetResourcePlans: type: object - description: Request object for changing the target status of a deployment (currently - only STOPPED is supported) - properties: - targetStatus: - $ref: '#/components/schemas/AiDeploymentTargetStatus' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - AiDeploymentModificationRequestWithIdentifier: + additionalProperties: + type: object + required: + - provisioned + - requested + properties: + provisioned: + type: integer + requested: + type: integer + BckndInstanceType: type: object - required: - - targetStatus - - id - properties: - id: - $ref: '#/components/schemas/AiDeploymentId' - targetStatus: - type: string - description: Deployment target status - enum: - - STOPPED - - DELETED - description: Request object for changing the target status of a deployment ( - STOPPED and DELETED are supported) - AiDeploymentModificationRequestList: - type: array - items: - $ref: '#/components/schemas/AiDeploymentModificationRequestWithIdentifier' - uniqueItems: true - minItems: 1 - maxItems: 100 - example: - - id: aa97b177-9383-4934-8543-0f91a7a0283a - targetStatus: STOPPED - - id: qweq32131-qwee-1231-8543-0f91a7a2e2e - targetStatus: DELETED - AiDeploymentBulkModificationRequest: + additionalProperties: + type: object + required: + - memory + - cpu + - gpu + - billableUnitsPerHour + properties: + memory: + type: string + description: Memory allocated for the instance type (e.g., "16Gi") + cpu: + type: number + description: Number of CPU cores allocated for the instance type + gpu: + type: number + description: Number of GPUs allocated for the instance type + billableUnitsPerHour: + type: number + description: Number of billable units per hour for the instance type + BckndErrorResponse: type: object - description: Request object for changing the target status of multiple deployments properties: - deployments: - $ref: '#/components/schemas/AiDeploymentModificationRequestList' - AiDeploymentModificationResponse: + error: + $ref: '#/components/schemas/BckndError' + BckndError: type: object - properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiDeploymentModificationResponseMessage' required: - - id + - code - message - AiDeploymentModificationResponseList: - type: array - items: - oneOf: - - $ref: '#/components/schemas/AiDeploymentModificationResponse' - - $ref: '#/components/schemas/AiApiErrorWithId' - AiDeploymentBulkModificationResponse: - type: object - description: Response object with array of deployments - properties: - deployments: - $ref: '#/components/schemas/AiDeploymentModificationResponseList' - AiDeploymentDeletionResponse: - type: object properties: - id: - $ref: '#/components/schemas/AiId' + code: + type: string + description: Descriptive error code (not http status code) message: - $ref: '#/components/schemas/AiDeploymentDeletionResponseMessage' - required: - - id - - message - AiDeploymentModificationResponseMessage: - type: string - description: Message - example: Deployment modification scheduled - AiDeploymentDeletionResponseMessage: - type: string - description: Message - example: Deployment deletion scheduled - AiDeploymentResponseWithDetails: - type: object - description: Detail properties of the deployment - properties: - id: - $ref: '#/components/schemas/AiDeploymentId' - deploymentUrl: - $ref: '#/components/schemas/AiDeploymentUrl' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - configurationName: - $ref: '#/components/schemas/AiConfigurationName' - executableId: - $ref: '#/components/schemas/AiExecutableId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - status: - $ref: '#/components/schemas/AiDeploymentStatus' - statusMessage: - $ref: '#/components/schemas/AiDeploymentStatusMessage' - targetStatus: type: string - description: Deployment target status - enum: - - RUNNING - - STOPPED - - DELETED - lastOperation: + description: Plaintext error description + example: something went wrong + requestId: type: string - description: Last operation applied to this deployment. - anyOf: - - enum: - - CREATE - - UPDATE - - DELETE - - CASCADE-UPDATE - - {} - latestRunningConfigurationId: + description: ID of the individual request + target: type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: configurationId that was running before a PATCH operation has - modified the configurationId of the deployment. This can be used for a - manual rollback in case the new configurationId results in a DEAD deployment - ttl: - $ref: '#/components/schemas/AiDeploymentTimeToLive' + description: Invoked URL details: - $ref: '#/components/schemas/AiDeploymentDetails' - createdAt: - type: string - description: Timestamp of resource creation - format: date-time - modifiedAt: + description: Optional details of the error message + type: object + DSetUrl: + type: string + format: url + example: https://download.example.com/test/file.bin + DSetError: + description: Error Response + type: object + properties: + code: type: string - format: date-time - description: Timestamp of latest resource modification - submissionTime: + minLength: 1 + message: type: string - format: date-time - description: Timestamp of job submitted - startTime: + minLength: 1 + target: type: string - format: date-time - description: Timestamp of job status changed to RUNNING - completionTime: + minLength: 1 + requestId: type: string - format: date-time - description: Timestamp of job status changed to COMPLETED/DEAD/STOPPED - statusDetails: - $ref: '#/components/schemas/AiDeploymentStatusDetails' + details: + type: array + uniqueItems: true + minItems: 0 + items: + required: + - code + - message + properties: + code: + type: string + minLength: 1 + message: + type: string + minLength: 1 required: - - id - - configurationId - - status - - createdAt - - modifiedAt - AiBackendDetails: - type: object - description: backend-specific details of the deployment - AiScalingDetails: - type: object - description: Scaling details of a deployment - example: - backendDetails: - predictor: - minReplicas: 0 - maxReplicas: 2 - runningReplicas: 1 - properties: - backendDetails: - $ref: '#/components/schemas/AiBackendDetails' - AiResourcesDetails: + - code + - message + x-examples: + example-1: + code: '03021655' + message: Bad request encountered. Please try again with possible-solution-here. + target: /url/path + requestId: 9832bf934f3743v3948v3 + details: + - code: '01041211' + message: Optional nested error message. + DSetFileCreationResponse: + description: Response for successful file creation type: object - description: Resources details of a deployment - example: - backendDetails: - predictor: - resourcePlan: starter + required: + - message + - url properties: - backendDetails: - $ref: '#/components/schemas/AiBackendDetails' - AiDeploymentDetails: + message: + type: string + description: File creation response message + example: File creation acknowledged + url: + $ref: '#/components/schemas/DSetUrl' + KpiColumnName: + readOnly: true + type: string + description: Name of the Column + anyOf: + - enum: + - ResourceGroup + - Scenario + - Executable + - Executions + - Artifacts + - Deployments + - {} + KpiArrayOfColumnNames: + uniqueItems: true + type: array + readOnly: true + items: + $ref: '#/components/schemas/KpiColumnName' + KpiAggregationAttribute: + type: string + title: Aggregation Attribute + readOnly: true + KpiCountAggregate: + type: integer + title: CountAggregate + format: int64 + minimum: 0 + x-examples: {} + readOnly: true + KpiResultRow: + type: array + title: ResultRow + uniqueItems: false + x-examples: {} + description: '' + items: + $ref: '#/components/schemas/KpiResultRowItem' + readOnly: true + KpiResultRowItem: + title: ResultRowItem + anyOf: + - $ref: '#/components/schemas/KpiAggregationAttribute' + - $ref: '#/components/schemas/KpiCountAggregate' + x-examples: {} + KpiResultRowList: + title: ResultRowList + type: array + items: + $ref: '#/components/schemas/KpiResultRow' + KpiResultSet: type: object - description: 'Detail information about a deployment (including predefined sections: - `scaling` and `resources`). - - JSON String representation of this object is limited to 5000 characters - - ' + title: ResultSet + x-examples: + example-1: + header: + - ResourceGroup + - Executions + - Artifacts + - Deployments + rows: + - - 00112233-4455-6677-8899-aabbccddeeff + - 30 + - 30 + - 3 + additionalProperties: false + minProperties: 2 + maxProperties: 2 properties: - scaling: - $ref: '#/components/schemas/AiScalingDetails' - resources: - $ref: '#/components/schemas/AiResourcesDetails' - AiDeploymentTimeToLive: + header: + $ref: '#/components/schemas/KpiArrayOfColumnNames' + rows: + $ref: '#/components/schemas/KpiResultRowList' + readOnly: true + KpiApiError: + type: object + required: + - code + - message + properties: + code: + type: string + description: Descriptive error code (not http status code) + message: + type: string + description: Plaintext error description + requestId: + type: string + description: ID of the individual request + target: + type: string + description: Invoked URL + details: + description: Optional details of the error message + type: object + RTAId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: Generic ID + RTATtl: type: string - description: Time to live for a deployment. Its value can be either null or - a number followed by the unit (any of following values, minutes(m|M), hours(h|H) - or days(d|D)) - nullable: true pattern: ^[0-9]+[m,M,h,H,d,D]$ example: 24H - AiArtifact: - description: 'Base data of the artifact; this is the data that can be provided - when the artifact is created; `name` and `kind` are required because they - constitute important semantic filtering criteria for use in training / inference - executables (`name` is a semantic handle of the artifact within a scenario - and `kind` specifies the type of usage, e.g. you would only want to allow - models in the model operator). - - ' + description: TTL value of deployment + RTALabelList: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/RTALabel' + RTAArtifactLabelList: + type: array + description: Arbitrary labels as meta information + items: + $ref: '#/components/schemas/RTAArtifactLabel' + RTALabel: + type: object + required: + - key + - value + properties: + key: + type: string + example: ai.sap.com/scenarioName + pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*ai\.sap\.com\/[\w\.-]+$ + value: + type: string + maxLength: 5000 + RTAArtifactLabel: type: object + required: + - key + - value properties: - labels: - $ref: '#/components/schemas/AiLabelList' + key: + type: string + example: ext.ai.sap.com/s4hana-version + pattern: ^ext\.ai\.sap\.com\/[\w\.-]+$ + maxLength: 256 + value: + type: string + maxLength: 5000 + RTACreationResponseMessage: + type: string + description: Message + example: Created + RTAScenarioId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the scenario + RTAScenario: + type: object + description: Entity having labels + required: + - id + - name + - createdAt + - modifiedAt + properties: + id: + $ref: '#/components/schemas/RTAScenarioId' name: - $ref: '#/components/schemas/AiArtifactName' - kind: type: string - enum: - - model - - dataset - - resultset - - other - description: Kind of the artifact, i.e. model or dataset - url: - $ref: '#/components/schemas/AiArtifactUrl' + maxLength: 256 + description: Name of the scenario description: - $ref: '#/components/schemas/AiArtifactDescription' - id: - $ref: '#/components/schemas/AiArtifactId' - scenarioId: - $ref: '#/components/schemas/AiScenarioId' - configurationId: - $ref: '#/components/schemas/AiConfigurationId' - executionId: - $ref: '#/components/schemas/AiExecutionId' + type: string + maxLength: 5000 + description: Description of the scenario + labels: + $ref: '#/components/schemas/RTALabelList' createdAt: type: string description: Timestamp of resource creation @@ -6439,337 +5811,819 @@ components: type: string format: date-time description: Timestamp of latest resource modification - scenario: - type: object - nullable: true - anyOf: - - $ref: '#/components/schemas/AiScenario' - - {} - required: - - name - - kind - - url - - id - - scenarioId - - createdAt - - modifiedAt - AiArtifactDescription: + RTAExecutableId: type: string - maxLength: 5000 - description: Description of the artifact - AiArtifactPostData: + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the executable + RTAExecutable: + description: Entity having labels type: object - description: 'Base data of the artifact; this is the data that can be provided - when the artifact is created; `name` and `kind` are required because they - constitute important semantic filtering criteria for use in training / inference - executables (`name` is a semantic handle of the artifact within a scenario - and `kind` specifies the type of usage, e.g. you would only want to allow - models in the model operator). - - ' required: + - id - name - - kind - - url - scenarioId + - deployable + - createdAt + - modifiedAt properties: - labels: - $ref: '#/components/schemas/AiLabelList' + id: + $ref: '#/components/schemas/RTAExecutableId' name: - $ref: '#/components/schemas/AiArtifactName' - kind: type: string - enum: - - model - - dataset - - resultset - - other - description: Kind of the artifact, i.e. model or dataset - url: - $ref: '#/components/schemas/AiArtifactUrl' + description: Name of the executable description: - $ref: '#/components/schemas/AiArtifactDescription' + type: string + description: Description of the executable scenarioId: - $ref: '#/components/schemas/AiScenarioId' - AiArtifactCreationResponse: + $ref: '#/components/schemas/RTAScenarioId' + inputArtifacts: + $ref: '#/components/schemas/RTAExecutableInputArtifactList' + outputArtifacts: + $ref: '#/components/schemas/RTAExecutableOutputArtifactList' + parameters: + $ref: '#/components/schemas/RTAExecutableParameterList' + deployable: + type: boolean + description: Whether this pipeline is deployable + example: false + labels: + $ref: '#/components/schemas/RTALabelList' + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + RTAExecutableParameterList: + type: array + description: Executable parameters + items: + $ref: '#/components/schemas/RTAExecutableParameter' + RTAExecutableParameter: type: object + description: Argument of an executable required: - - id - - message - - url - properties: - id: - $ref: '#/components/schemas/AiId' - message: - $ref: '#/components/schemas/AiArtifactCreationResponseMessage' - url: - $ref: '#/components/schemas/AiArtifactUrl' - AiArtifactCreationResponseMessage: - type: string - description: Message - example: Artifact acknowledged - AiArtifactId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: ID of the artifact - AiArtifactName: - type: string - pattern: ^[\w\s.!?,;:\[\](){}<>"'=+*/\\^&%@~$#|-]*$ - maxLength: 256 - description: Name of the artifact - AiArtifactUrl: - type: string - pattern: ([a-z0-9-]+):\/\/.+ - maxLength: 1024 - example: https://example.com/some_path - description: 'Reference to the location of the artifact. - - ' - AiArtifactList: - type: object + - name properties: - count: - type: integer - description: Number of the resource instances in the list - resources: - $ref: '#/components/schemas/AiArtifactArray' - required: - - count - - resources - AiArtifactArray: + name: + type: string + description: Name of the signature argument + description: + type: string + maxLength: 5000 + description: Description of the signature argument + default: + type: string + description: Default value of the signature argument + type: + type: string + enum: + - string + description: Type of the signature argument + RTAExecutableInputArtifactList: type: array + description: List of Artifacts that the executable expects as input artifacts items: - $ref: '#/components/schemas/AiArtifact' - AiLogCommonData: - type: object - properties: - result: - $ref: '#/components/schemas/AiLogCommonResult' - AiLogCommonResult: + $ref: '#/components/schemas/RTAExecutableArtifact' + RTAExecutableOutputArtifactList: type: array + description: List of Artifacts that the executable will produce. If storage + is not managed internally, a storage location will have to be specified when + triggering an execution items: - $ref: '#/components/schemas/AiLogCommonResultItem' - AiLogCommonResultItem: + $ref: '#/components/schemas/RTAExecutableArtifact' + RTAExecutableArtifact: type: object - description: Common log record. + description: Input or output artifact + required: + - name properties: - timestamp: - description: Datetime in RFC 3339. + name: type: string - format: date-time - example: '2021-05-19T00:00:14.347+00:00' - msg: - description: message content. + description: Name of the signature argument + description: type: string - AiId: - type: string - pattern: ^[\w.-]{4,64}$ - example: aa97b177-9383-4934-8543-0f91a7a0283a - description: Generic ID - AiVersionId: - description: Version ID - type: string - AiVersionDescription: - type: string - maxLength: 5000 - example: This is version v1 - description: Version description - AiCreationResponseMessage: - type: string - description: Message - example: Created - AiUrl: - type: string - format: url - AiApiErrorWithId: + maxLength: 5000 + description: Description of the signature argument + kind: + type: string + description: Kind of the artifact, i.e. model or dataset + labels: + $ref: '#/components/schemas/RTAArtifactLabelList' + RTAModelBaseData: type: object required: - - id - - error + - model + - executableId + - description + - versions properties: - id: - $ref: '#/components/schemas/AiId' - error: - $ref: '#/components/schemas/AiApiError' - AiApiError: + model: + type: string + description: Name of the model + executableId: + $ref: '#/components/schemas/RTAExecutableId' + description: + type: string + description: Description of the model and its capabilities + versions: + $ref: '#/components/schemas/RTAModelVersionList' + displayName: + type: string + description: Display name of the model + accessType: + type: string + description: Access type of the model + provider: + type: string + description: Provider of the model + allowedScenarios: + type: array + description: List of scenarioId:executuableId pair where the model supported + items: + type: object + required: + - scenarioId + - executableId + properties: + scenarioId: + $ref: '#/components/schemas/RTAScenarioId' + executableId: + $ref: '#/components/schemas/RTAExecutableId' + RTAModelVersionList: + type: array + description: List of model versions that the model object has + items: + $ref: '#/components/schemas/RTAModelVersion' + RTAModelVersion: type: object + description: Model version information including whether it is latest version, + its deprecation status and retirement date required: - - code - - message + - name + - isLatest + - deprecated properties: - code: - type: string - description: Descriptive error code (not http status code) - message: - type: string - description: Plaintext error description - requestId: + name: type: string - description: ID of the individual request - target: + description: Name of model version + isLatest: + type: boolean + description: Displays whether it is the latest version offered for the model + deprecated: + type: boolean + description: Deprecation status of model + retirementDate: type: string - description: Invoked URL - details: - description: Optional details of the error message - type: object - parameters: - KpiquerySelect: - name: $select - description: Columns to select - in: query - required: false - schema: - uniqueItems: true - type: array - readOnly: true - default: - - ResourceGroup - - Executions - - Artifacts - - Deployments - items: - $ref: '#/components/schemas/KpiColumnName' - style: form - explode: false - RTAtokenHeader: - name: Authorization - in: header - description: Authorization bearer token containing a JWT token. - required: false - schema: - type: string - RTAlimit: - in: query - name: $top - description: The max number of entries to return. Defaults to 1000. Limited - to 5000 max. - required: false - schema: - type: integer - minimum: 1 - maximum: 5000 - default: 1000 - examples: - min: - value: 1 - summary: Min number of entries to return - max: - value: 5000 - summary: Max number of entries to return - default: - value: 1000 - summary: default number of entries to return - RTAstart: - name: start - in: query - description: The start time for the query as a RFC 3339 datetime format. Defaults - to one hour ago. + in timezone need to be encoded to %2B. - required: false - schema: - type: string - format: date-time - examples: - zulu: - value: '2021-05-19T00:00:14.347Z' - summary: Datetime example use Z as timezone - utc: - value: 2021-05-19T00:00:14.347%2B00:00 - summary: Datetime example use +00:00 as timezone, where + is encoded to - %2B - local-plus: - value: 2021-05-19T08:00:14.347%2B08:00 - summary: Datetime example use +08:00 as timezone, where + is encoded to - %2B - local-minus: - value: '2021-05-18T16:00:14.347-08:00' - summary: Datetime example use -08:00 as timezone - RTAend: - name: end - in: query - description: The end time for the query as a RFC 3339 datetime format. Defaults - to now. + in timezone need to be encoded to %2B. - required: false - schema: - type: string - format: date-time - examples: - zulu: - value: '2021-05-19T01:00:14.347Z' - summary: Datetime example use Z as timezone - utc: - value: 2021-05-19T01:00:14.347%2B00:00 - summary: Datetime example use +00:00 as timezone, where + is encoded to - %2B - local-plus: - value: 2021-05-19T09:00:14.347%2B08:00 - summary: Datetime example use +08:00 as timezone, where + is encoded to - %2B - local-minus: - value: '2021-05-18T17:00:14.347-08:00' - summary: Datetime example use -08:00 as timezone - RTAorder: - name: $order - in: query - description: "Determines the sort order. Supported values are asc or desc. Defaults - to asc. Sort order:\n * `asc` - Ascending, earliest in the order will appear - at the top of the list\n * `desc` - Descending, last in the order will appear - at the top of the list\n" - required: false - schema: - type: string - enum: - - asc - - desc - examples: - asc: - value: asc - summary: Sort the results in ascending order - desc: - value: desc - summary: Sort the results in descending order - RTAexecutionId: - name: executionId - description: Execution identifier - in: path - required: true - schema: - type: string - pattern: ^[\w.-]{4,64}$ + description: Retirement date of model in ISO 8601 timestamp + contextLength: + type: integer + description: Context length of the model + inputTypes: + type: array + description: List of input types supported by the model + items: + type: string + capabilities: + type: array + description: List of capabilities supported by the model + items: + type: string + metadata: + type: array + description: List of metadata supported by the model + items: + type: object + additionalProperties: + type: string + cost: + type: array + description: List of costs associated with the model + items: + type: object + additionalProperties: + type: string + suggestedReplacements: + type: array + description: List of suggested replacements for the model + items: + type: string + streamingSupported: + type: boolean + description: Streaming support status of the model + orchestrationCapabilities: + type: array + description: List of model capabilities supported by orchestration service + items: + type: string + RTAArtifact: + description: Entity having labels + type: object + required: + - name + - url + - executionId + - kind + - createdAt + properties: + name: + type: string + maxLength: 256 + description: Name of the artifact; this is used for dependent pipelines + to resolve an artifact + executionId: + $ref: '#/components/schemas/RTAExecutionId' + url: + $ref: '#/components/schemas/RTAArtifactUrl' + signature: + $ref: '#/components/schemas/RTAArtifactSignature' + kind: + type: string + enum: + - model + - dataset + - resultset + - other + description: Kind of the artifact, i.e. model or dataset + labels: + $ref: '#/components/schemas/RTALabelList' + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + RTAArtifactName: + type: string + maxLength: 256 + RTAArtifactUrl: + type: string + pattern: ([a-z0-9-]+):\/\/.+ + maxLength: 1024 + example: s3://some_bucket/some_path + description: 'Reference to the location of the artifact. + + Note, the credentials will be found in a secret called + + ''some_bucket-object_store_secret''. If not provided, a default will be assumed. + + ' + RTAArtifactSignature: + type: string + maxLength: 256 + RTAArtifactArray: + type: array + items: + $ref: '#/components/schemas/RTAArtifact' + RTADeployment: + type: object + description: Detailed data about an inference-pipeline deployment + required: + - scenarioId + - executableId + - createdAt + - modifiedAt + properties: + scenarioId: + $ref: '#/components/schemas/RTAScenarioId' + executableId: + $ref: '#/components/schemas/RTAExecutableId' + id: + $ref: '#/components/schemas/RTADeploymentId' + deploymentUrl: + $ref: '#/components/schemas/RTADeploymentUrl' + latestRunningTargetId: + $ref: '#/components/schemas/RTALatestRunningTargetId' + targetId: + $ref: '#/components/schemas/RTATargetId' + ttl: + $ref: '#/components/schemas/RTATtl' + status: + type: string + description: Deployment status + enum: + - PENDING + - RUNNING + - COMPLETED + - DEAD + - UNKNOWN + - DELETING + statusMessage: + type: string + description: Deployment status message + maxLength: 256 + lastOperation: + type: string + description: Reflection of user's action on deployment. The value will be + CREATE after user sends POST - create deployment, UPDATE after user sends + PATCH - update deployment, and DELETE after user sends DELETE - delete + deployment + enum: + - CREATE + - UPDATE + - CASCADE-UPDATE + - DELETE + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + RTADeploymentId: + type: string + pattern: ^[\w.-]{4,64}$ example: aa97b177-9383-4934-8543-0f91a7a0283a - RTAdeploymentId: - name: deploymentId - description: Deployment identifier - in: path - required: true - schema: - type: string - pattern: ^[\w.-]{4,64}$ + description: ID of the deployment + RTATargetId: + type: string + pattern: ^[\w.-]{4,64}$ example: aa97b177-9383-4934-8543-0f91a7a0283a - DSetresourceGroupHeader: - in: header - name: AI-Resource-Group - description: Specify a resource group id - schema: - type: string - required: false - DSetpath: - name: path - in: path - required: true - schema: - type: string - format: path - pattern: ^(([\w.-]+):([\w.-]+)|([\w.-]+))(/([\w./-]+[\w.-]+)?)?$ - maxLength: 1024 - description: path relative to the object store root URL in the secret - DSetoverwrite: - name: overwrite - in: query - required: false - schema: - type: boolean - description: If true, then file is overwritten. Default is false. + description: Client provided reference, with which the status of a PATCHed deployment + can be tracked + RTALatestRunningTargetId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: Target ID of the latest running deployment + RTADeploymentUrl: + description: Consumption URL of the pipeline deployment + type: string + format: url + RTADeploymentCreationResponseMessage: + type: string + description: Message + example: Deployment scheduled + RTADeploymentCascadeUpdateResponseMessage: + type: string + description: Message + example: Deployment Cascade Update scheduled + RTADeploymentDeletionResponseMessage: + type: string + description: Message + example: Deployment deletion scheduled + RTADeploymentModificationResponseMessage: + type: string + description: Message + example: Deployment modification scheduled + RTADeploymentStatusDetails: + type: object + description: Current status details of the deployment + RTADeploymentDetails: + type: object + properties: + scaling: + $ref: '#/components/schemas/RTABackendDetails' + resources: + $ref: '#/components/schemas/RTABackendDetails' + RTABackendDetails: + type: object + properties: + backendDetails: + type: object + description: Current details of the deployment + RTAExecution: + type: object + description: Execution + required: + - scenarioId + - executableId + - createdAt + - modifiedAt + properties: + scenarioId: + $ref: '#/components/schemas/RTAScenarioId' + executableId: + $ref: '#/components/schemas/RTAExecutableId' + id: + $ref: '#/components/schemas/RTAExecutionId' + status: + type: string + description: Status of the execution + enum: + - PENDING + - RUNNING + - COMPLETED + - DEAD + - STOPPING + - STOPPED + - UNKNOWN + example: COMPLETED + statusMessage: + type: string + description: Execution status message + maxLength: 256 + submissionTimestamp: + type: string + description: Timestamp of execution submission + format: date-time + example: '2017-09-15T12:01:06Z' + nullable: true + startTimestamp: + type: string + description: Timestamp of execution start + format: date-time + example: '2017-09-15T12:01:06Z' + nullable: true + finishTimestamp: + type: string + description: Timestamp of execution finish + format: date-time + example: '2017-09-15T12:01:06Z' + nullable: true + createdAt: + type: string + description: Timestamp of resource creation + format: date-time + modifiedAt: + type: string + format: date-time + description: Timestamp of latest resource modification + RTAInputArtifactArgumentBinding: + type: object + required: + - name + - url + properties: + name: + $ref: '#/components/schemas/RTAArtifactName' + url: + $ref: '#/components/schemas/RTAArtifactUrl' + signature: + $ref: '#/components/schemas/RTAArtifactSignature' + description: Required for execution + RTAOutputArtifactArgumentBinding: + type: object + required: + - name + properties: + name: + $ref: '#/components/schemas/RTAArtifactName' + url: + $ref: '#/components/schemas/RTAArtifactUrl' + description: Result of execution + RTAExecutableArgumentBinding: + type: object + required: + - key + - value + properties: + key: + type: string + maxLength: 256 + value: + type: string + description: 'Required for execution + + Result of activation + + ' + RTAExecutionId: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + description: ID of the execution + RTAExecutionCreationResponseMessage: + type: string + description: Message + example: Execution scheduled + RTAExecutionModificationResponseMessage: + type: string + description: Message + example: Execution modification scheduled + RTAExecutionDeletionResponseMessage: + type: string + description: Message + example: Execution deletion scheduled + RTAExecutionStatusDetails: + type: object + description: Current status details of the execution + RTALogCommonResponse: + type: object + properties: + data: + $ref: '#/components/schemas/RTALogCommonData' + description: 'A common log query response. + + ' + RTALogCommonData: + type: object + properties: + result: + $ref: '#/components/schemas/RTALogCommonResult' + RTALogCommonResult: + type: array + items: + $ref: '#/components/schemas/RTALogCommonResultItem' + RTALogCommonResultItem: + type: object + description: Common log record. + properties: + timestamp: + $ref: '#/components/schemas/RTAtimestamp' + msg: + $ref: '#/components/schemas/RTAmessage' + RTAtimestamp: + description: Datetime in RFC 3339. + type: string + format: date-time + example: '2021-05-19T00:00:14.347+00:00' + RTAmessage: + description: message content. + type: string + RTAErrorResponse: + type: object + properties: + error: + $ref: '#/components/schemas/RTAError' + RTAError: + type: object + required: + - code + - message + properties: + code: + type: string + description: Descriptive error code (not http status code) + message: + type: string + description: Plaintext error description + example: something went wrong + requestId: + type: string + description: ID of the individual request + target: + type: string + description: Invoked URL + details: + description: Optional details of the error message + type: object + MetaCapabilities: + type: object + required: + - aiApi + properties: + runtimeIdentifier: + type: string + example: aicore + description: The name of the runtime + runtimeApiVersion: + $ref: '#/components/schemas/MetaVersion' + description: + type: string + aiApi: + $ref: '#/components/schemas/MetaAiApi' + extensions: + $ref: '#/components/schemas/MetaExtensions' + MetaExtensions: + type: object + properties: + analytics: + type: object + required: + - version + properties: + version: + $ref: '#/components/schemas/MetaVersion' + resourceGroups: + type: object + required: + - version + properties: + version: + $ref: '#/components/schemas/MetaVersion' + dataset: + type: object + properties: + version: + $ref: '#/components/schemas/MetaVersion' + capabilities: + description: List of Dataset extension capabilities + type: object + properties: + upload: + description: Support for uploading of files + type: boolean + default: true + download: + description: Support for downloading of files + type: boolean + default: true + delete: + description: Support for deletion of files + type: boolean + default: true + limits: + type: object + properties: + maxUploadFileSize: + type: integer + description: Max size (in bytes) of a single uploaded file allowed + by this runtime per resource group. + default: 104857600 + maxFilesPerDataset: + description: Max number of files per dataset. <0 means unlimited. + type: integer + default: -1 + acceptedContentTypes: + type: array + items: + type: string + pattern: ^\w+\/([\w+-]\.)?[\w.-]+(\+[\w-]+)*$ + required: + - version + metrics: + type: object + properties: + version: + $ref: '#/components/schemas/MetaVersion' + capabilities: + description: List of Metrics extension capabilities + type: object + properties: + extendedResults: + description: Support for returning extended results + type: boolean + default: false + required: + - version + MetaAiApi: + description: There are (currently) the following types of execution engines 1) + complete runtimes that offer executions and deployments, 2) runtimes that + do only batch inference and therefore don't support deployments 3) runtimes + that allow deployments, but with predefined models and therefore don't need + executions 4) runtimes that have fixed endpoints and therefore only need listing + deployments + type: object + properties: + version: + $ref: '#/components/schemas/MetaVersion' + capabilities: + type: object + properties: + multitenant: + type: boolean + description: true-> AI API implementation supports resource groups (Main + Tenant scenario), false-> implementation does not support resource + groups (Service Tenant scenario) + default: true + shareable: + type: boolean + description: true-> clients can use just one instance (global static + models), false-> clients should avoid sharing an instance + default: true + staticDeployments: + type: boolean + description: There are static always running endpoints that can be used + for inference without the need to do user deployments. + default: true + userDeployments: + type: boolean + description: Services that only support batch inference typically neither + allow listing nor creation of deployments. For these, userDeployments + == false + default: true + userExecutions: + type: boolean + default: true + timeToLiveDeployments: + type: boolean + default: false + executionSchedules: + type: boolean + default: false + logs: + type: object + properties: + executions: + type: boolean + default: true + deployments: + type: boolean + default: true + bulkUpdates: + type: object + description: Services that support patch on /executions and /deployments + to change targetStatus of multiple executions and deployments. + properties: + executions: + type: boolean + default: false + deployments: + type: boolean + default: false + limits: + type: object + properties: + executions: + type: object + properties: + maxRunningCount: + description: Max nr of executions allowed by this runtime per resource + group. <0 means unlimited. + type: integer + default: -1 + deployments: + type: object + properties: + maxRunningCount: + description: Max nr of deployments allowed by this runtime per resource + group. <0 means unlimited. + type: integer + default: -1 + timeToLiveDeployments: + type: object + properties: + minimum: + type: string + default: 10m + maximum: + type: string + default: '-1' + required: + - version + MetaVersion: + example: 1.2.3 + type: string + pattern: + ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ + MetaAPIVersion: + type: object + properties: + versionId: + type: string + description: API version identifier + example: v1 + url: + type: string + description: URL of the API version + example: https://api.example.com/v1 + description: + type: string + description: version description + example: Example API + description: API version description + MetaApiError: + type: object + required: + - code + - message + properties: + code: + type: string + description: Descriptive error code (not http status code) + message: + type: string + description: Plaintext error description + requestId: + type: string + description: ID of the individual request + target: + type: string + description: Invoked URL + details: + description: Optional details of the error message + type: object + TntTenantInfo: + type: object + required: + - tenantId + - servicePlan + - status + properties: + tenantId: + description: tenant id + type: string + example: aa97b177-9383-4934-8543-0f91a7a0283a + servicePlan: + type: string + status: + description: Provisioning status of the tenant + type: string + TntApiError: + type: object + required: + - code + - message + properties: + code: + type: string + description: Descriptive error code (not http status code) + message: + type: string + description: Plaintext error description + requestId: + type: string + description: ID of the individual request + target: + type: string + description: Invoked URL + details: + description: Optional details of the error message + type: object + parameters: TrckqueryFilter: example: executionId eq 'aa97b177-9383-4934-8543-0f91b7a0283a' name: $filter @@ -6833,173 +6687,31 @@ components: required: true TrcktrackingResourceGroupHeader: name: AI-Resource-Group - description: Specify a resource group id - in: header - schema: - type: string - required: true - Trcktop: - name: $top - description: Number of results to display - in: query - required: false - schema: - type: integer - maximum: 10000 - default: 1000 - example: 10 - x-visible: false - Trckskip: - name: $skip - description: Number of results to be skipped from the ordered list of results - in: query - required: false - schema: - type: integer - example: 10 - x-visible: false - BckndtokenHeader: - name: Authorization - in: header - description: Authorization bearer token containing a JWT token. - required: false - schema: - type: string - Bckndai-resource-group: - name: AI-Resource-Group - in: header - description: Specify an existing resource group id to use - required: false - schema: - type: string - Bckndai-resource-group-default: - name: AI-Resource-Group - in: header - description: Specify an existing resource group id to use. Uses "default" if - value not provided. - required: false - schema: - type: string - default: default - Bckndai-tenant-scope: - name: AI-Tenant-Scope - in: header - description: Specify whether the main tenant scope is to be used - required: false - schema: - type: boolean - example: true - Bckndtop: - name: $top - description: Number of results to display - in: query - required: false - schema: - type: integer - minimum: 0 - example: 10 - Bckndskip: - name: $skip - description: Number of results to be skipped from the ordered list of results - in: query - required: false - schema: - type: integer - minimum: 0 - example: 10 - Bckndcount: - name: $count - description: When the $count field is set to false, the response contains a - count of the items present in the response. When the $count field is set to - true, the response contains a count of all the items present on the server, - and not just the ones in the response. When the $count field is not passed, - it is false by default. - in: query - required: false - schema: - type: boolean - example: true - BckndresourceGroupId: - name: resourceGroupId - description: Resource group identifier - in: path - required: true - schema: - type: string - pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ - minLength: 3 - maxLength: 253 - example: my-test-rg - BckndobjectStoreName: - name: objectStoreName - description: Name of the object store for the secret. - in: path - required: true - schema: - type: string - pattern: ^[a-zA-Z0-9\.\-_]+$ - example: My_objectStore - BcknddockerRegistryName: - name: dockerRegistryName - description: Name of the docker Registry store for the secret. - in: path - required: true - schema: - type: string - pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ - maxLength: 63 - example: mydockeregistry - BckndsecretName: - name: secretName - in: path - required: true - schema: - type: string - minLength: 1 - maxLength: 252 - pattern: ^[a-z0-9\-\.]+$ - BckndrepositoryName: - name: repositoryName - description: Name of the repository - in: path - required: true - schema: - type: string - minLength: 1 - maxLength: 51 - pattern: ^[a-z0-9\-]+$ - example: tenant-application - BckndapplicationName: - name: applicationName - description: Name of the ArgoCD application - in: path - required: true - schema: - type: string - minLength: 3 - maxLength: 54 - pattern: ^[a-z0-9\-]+$ - example: tenant-application - BckndServiceName: - name: ServiceName - description: Name of the Service - in: path - required: true + description: Specify a resource group id + in: header schema: type: string - pattern: ^[a-zA-Z0-9\-_]+$ - minLength: 1 - maxLength: 32 - example: cashapp - BckndquotaOnly: - name: quotaOnly - description: When being set to true, the response contains only the quota of - the resource and not the quota usage. + required: true + Trcktop: + name: $top + description: Number of results to display in: query required: false schema: - type: boolean - example: true + type: integer + maximum: 10000 + default: 1000 + example: 10 + x-visible: false + Trckskip: + name: $skip + description: Number of results to be skipped from the ordered list of results + in: query + required: false + schema: + type: integer + example: 10 + x-visible: false AiresourceGroupHeader: in: header name: AI-Resource-Group @@ -7256,103 +6968,423 @@ components: required: false schema: type: integer - example: 10 - x-visible: false - AiqueryConfigurationExpand: - name: $expand - description: expand detailed information on scenario + example: 10 + x-visible: false + AiqueryConfigurationExpand: + name: $expand + description: expand detailed information on scenario + in: query + required: false + schema: + type: string + enum: + - scenario + example: scenario + x-visible: false + AiqueryArtifactExpand: + name: $expand + description: expand detailed information on scenario + in: query + required: false + schema: + type: string + enum: + - scenario + example: scenario + x-visible: false + Aiselect: + name: $select + description: Allows to request a specified set of properties for each entity + in: query + required: false + schema: + type: string + enum: + - status + example: status + x-visible: false + BckndtokenHeader: + name: Authorization + in: header + description: Authorization bearer token containing a JWT token. + required: false + schema: + type: string + Bckndai-resource-group: + name: AI-Resource-Group + in: header + description: Specify an existing resource group id to use + required: false + schema: + type: string + Bckndai-resource-group-default: + name: AI-Resource-Group + in: header + description: Specify an existing resource group id to use. Uses "default" if + value not provided. + required: false + schema: + type: string + default: default + Bckndai-tenant-scope: + name: AI-Tenant-Scope + in: header + description: Specify whether the main tenant scope is to be used + required: false + schema: + type: boolean + example: true + Bckndtop: + name: $top + description: Number of results to display + in: query + required: false + schema: + type: integer + minimum: 0 + example: 10 + Bckndskip: + name: $skip + description: Number of results to be skipped from the ordered list of results + in: query + required: false + schema: + type: integer + minimum: 0 + example: 10 + Bckndcount: + name: $count + description: When the $count field is set to false, the response contains a + count of the items present in the response. When the $count field is set to + true, the response contains a count of all the items present on the server, + and not just the ones in the response. When the $count field is not passed, + it is false by default. + in: query + required: false + schema: + type: boolean + example: true + BckndresourceGroupId: + name: resourceGroupId + description: Resource group identifier + in: path + required: true + schema: + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$ + minLength: 3 + maxLength: 253 + example: my-test-rg + BckndobjectStoreName: + name: objectStoreName + description: Name of the object store for the secret. + in: path + required: true + schema: + type: string + pattern: ^[a-zA-Z0-9\.\-_]+$ + example: My_objectStore + BcknddockerRegistryName: + name: dockerRegistryName + description: Name of the docker Registry store for the secret. + in: path + required: true + schema: + type: string + pattern: ^[a-z0-9](?:_?[a-z0-9\.\-]+)*[a-z0-9]$ + maxLength: 63 + example: mydockeregistry + BckndsecretName: + name: secretName + in: path + required: true + schema: + type: string + minLength: 1 + maxLength: 252 + pattern: ^[a-z0-9\-\.]+$ + BckndrepositoryName: + name: repositoryName + description: Name of the repository + in: path + required: true + schema: + type: string + minLength: 1 + maxLength: 51 + pattern: ^[a-z0-9\-]+$ + example: tenant-application + BckndapplicationName: + name: applicationName + description: Name of the ArgoCD application + in: path + required: true + schema: + type: string + minLength: 3 + maxLength: 63 + pattern: ^[a-z0-9\-]+$ + example: tenant-application + BckndServiceName: + name: ServiceName + description: Name of the Service + in: path + required: true + schema: + type: string + pattern: ^[a-zA-Z0-9\-_]+$ + minLength: 1 + maxLength: 32 + example: cashapp + BckndquotaOnly: + name: quotaOnly + description: When being set to true, the response contains only the quota of + the resource and not the quota usage. + in: query + required: false + schema: + type: boolean + example: true + DSetresourceGroupHeader: + in: header + name: AI-Resource-Group + description: Specify a resource group id + schema: + type: string + required: false + DSetpath: + name: path + in: path + required: true + schema: + type: string + format: path + pattern: ^(([\w.-]+):([\w.-]+)|([\w.-]+))(/([\w./-]+[\w.-]+)?)?$ + maxLength: 1024 + description: path relative to the object store root URL in the secret + DSetoverwrite: + name: overwrite + in: query + required: false + schema: + type: boolean + description: If true, then file is overwritten. Default is false. + KpiquerySelect: + name: $select + description: Columns to select + in: query + required: false + schema: + uniqueItems: true + type: array + readOnly: true + default: + - ResourceGroup + - Executions + - Artifacts + - Deployments + items: + $ref: '#/components/schemas/KpiColumnName' + style: form + explode: false + RTAtokenHeader: + name: Authorization + in: header + description: Authorization bearer token containing a JWT token. + required: false + schema: + type: string + RTAlimit: + in: query + name: $top + description: The max number of entries to return. Defaults to 1000. Limited + to 5000 max. + required: false + schema: + type: integer + minimum: 1 + maximum: 5000 + default: 1000 + examples: + min: + value: 1 + summary: Min number of entries to return + max: + value: 5000 + summary: Max number of entries to return + default: + value: 1000 + summary: default number of entries to return + RTAstart: + name: start in: query + description: The start time for the query as a RFC 3339 datetime format. Defaults + to one hour ago. + in timezone need to be encoded to %2B. required: false schema: type: string - enum: - - scenario - example: scenario - x-visible: false - AiqueryArtifactExpand: - name: $expand - description: expand detailed information on scenario + format: date-time + examples: + zulu: + value: '2021-05-19T00:00:14.347Z' + summary: Datetime example use Z as timezone + utc: + value: 2021-05-19T00:00:14.347%2B00:00 + summary: Datetime example use +00:00 as timezone, where + is encoded to + %2B + local-plus: + value: 2021-05-19T08:00:14.347%2B08:00 + summary: Datetime example use +08:00 as timezone, where + is encoded to + %2B + local-minus: + value: '2021-05-18T16:00:14.347-08:00' + summary: Datetime example use -08:00 as timezone + RTAend: + name: end in: query + description: The end time for the query as a RFC 3339 datetime format. Defaults + to now. + in timezone need to be encoded to %2B. required: false schema: type: string - enum: - - scenario - example: scenario - x-visible: false - Aiselect: - name: $select - description: Allows to request a specified set of properties for each entity + format: date-time + examples: + zulu: + value: '2021-05-19T01:00:14.347Z' + summary: Datetime example use Z as timezone + utc: + value: 2021-05-19T01:00:14.347%2B00:00 + summary: Datetime example use +00:00 as timezone, where + is encoded to + %2B + local-plus: + value: 2021-05-19T09:00:14.347%2B08:00 + summary: Datetime example use +08:00 as timezone, where + is encoded to + %2B + local-minus: + value: '2021-05-18T17:00:14.347-08:00' + summary: Datetime example use -08:00 as timezone + RTAorder: + name: $order in: query + description: "Determines the sort order. Supported values are asc or desc. Defaults + to asc. Sort order:\n * `asc` - Ascending, earliest in the order will appear + at the top of the list\n * `desc` - Descending, last in the order will appear + at the top of the list\n" required: false schema: type: string enum: - - status - example: status - x-visible: false + - asc + - desc + examples: + asc: + value: asc + summary: Sort the results in ascending order + desc: + value: desc + summary: Sort the results in descending order + RTAexecutionId: + name: executionId + description: Execution identifier + in: path + required: true + schema: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a + RTAdeploymentId: + name: deploymentId + description: Deployment identifier + in: path + required: true + schema: + type: string + pattern: ^[\w.-]{4,64}$ + example: aa97b177-9383-4934-8543-0f91a7a0283a responses: - MetaNotFound: - description: The specified resource was not found + TrckBadRequest: content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/MetaApiError' - KpiNotFound: - description: The specified resource was not found + $ref: '#/components/schemas/TrckApiError' + description: The specification of the resource was incorrect + TrckNotImplemented: content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/KpiApiError' - KpiTooManyRequests: - description: Too many requests + $ref: '#/components/schemas/TrckApiError' + description: Operation is not Supported. + TrckNotFound: + description: The specified resource was not found content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/KpiApiError' - KpiInvalidRequest: - description: Invalid request + $ref: '#/components/schemas/TrckApiError' + TrckPayloadTooLarge: content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/KpiApiError' - RTANotFound: + $ref: '#/components/schemas/TrckApiError' + description: request entity is larger than limits defined by server. + AiNotFound: description: The specified resource was not found content: application/json: schema: - $ref: '#/components/schemas/RTAErrorResponse' - RTABadRequest: - description: The request was malformed and could thus not be processed. + type: object + properties: + error: + $ref: '#/components/schemas/AiApiError' + AiPreconditionFailed: + description: The service didn't meet the precondition needed to execute this + operation content: application/json: schema: - $ref: '#/components/schemas/RTAErrorResponse' - RTACommonError: + type: object + properties: + error: + $ref: '#/components/schemas/AiApiError' + AiBadRequest: + description: The specification of the resource was incorrect + content: + application/json: + schema: + type: object + properties: + error: + $ref: '#/components/schemas/AiApiError' + BckndCommonError: description: HTTP status codes 401, 403 or 500. Response body contains further details. content: application/json: schema: - $ref: '#/components/schemas/RTAErrorResponse' - RTAUnauthorized: - description: Lacks valid authentication credentials for the target resource. + $ref: '#/components/schemas/BckndErrorResponse' + BckndNotFound: + description: The specified resource was not found content: application/json: schema: - $ref: '#/components/schemas/RTAErrorResponse' + $ref: '#/components/schemas/BckndErrorResponse' + BckndBadRequest: + description: The request was malformed and could thus not be processed. + content: + application/json: + schema: + $ref: '#/components/schemas/BckndErrorResponse' DSetBadRequest: description: The specification of the resource was incorrect content: @@ -7465,95 +7497,73 @@ components: the artifact API to register this file. schema: $ref: '#/components/schemas/DSetUrl' - TrckBadRequest: - content: - application/json: - schema: - type: object - properties: - error: - $ref: '#/components/schemas/TrckApiError' - description: The specification of the resource was incorrect - TrckNotImplemented: + KpiNotFound: + description: The specified resource was not found content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/TrckApiError' - description: Operation is not Supported. - TrckNotFound: - description: The specified resource was not found + $ref: '#/components/schemas/KpiApiError' + KpiTooManyRequests: + description: Too many requests content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/TrckApiError' - TrckPayloadTooLarge: + $ref: '#/components/schemas/KpiApiError' + KpiInvalidRequest: + description: Invalid request content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/TrckApiError' - description: request entity is larger than limits defined by server. - BckndCommonError: - description: HTTP status codes 401, 403 or 500. Response body contains further - details. - content: - application/json: - schema: - $ref: '#/components/schemas/BckndErrorResponse' - BckndNotFound: + $ref: '#/components/schemas/KpiApiError' + RTANotFound: description: The specified resource was not found content: application/json: schema: - $ref: '#/components/schemas/BckndErrorResponse' - BckndBadRequest: + $ref: '#/components/schemas/RTAErrorResponse' + RTABadRequest: description: The request was malformed and could thus not be processed. content: application/json: schema: - $ref: '#/components/schemas/BckndErrorResponse' - TntNotFound: - description: The specified resource was not found + $ref: '#/components/schemas/RTAErrorResponse' + RTACommonError: + description: HTTP status codes 401, 403 or 500. Response body contains further + details. content: application/json: schema: - type: object - properties: - error: - $ref: '#/components/schemas/TntApiError' - AiNotFound: - description: The specified resource was not found + $ref: '#/components/schemas/RTAErrorResponse' + RTAUnauthorized: + description: Lacks valid authentication credentials for the target resource. content: application/json: schema: - type: object - properties: - error: - $ref: '#/components/schemas/AiApiError' - AiPreconditionFailed: - description: The service didn't meet the precondition needed to execute this - operation + $ref: '#/components/schemas/RTAErrorResponse' + MetaNotFound: + description: The specified resource was not found content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/AiApiError' - AiBadRequest: - description: The specification of the resource was incorrect + $ref: '#/components/schemas/MetaApiError' + TntNotFound: + description: The specified resource was not found content: application/json: schema: type: object properties: error: - $ref: '#/components/schemas/AiApiError' + $ref: '#/components/schemas/TntApiError'