Skip to content

feat: [DevOps] Update prompt-registry specification #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sap-ai-sdk-bot wants to merge 1 commit into from
Closed

feat: [DevOps] Update prompt-registry specification #952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions ...registry/src/main/java/com/sap/ai/sdk/prompt/registry/client/OrchestrationConfigsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,9 @@ public OrchestrationConfigPostResponse importOrchestrationConfig()
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @param scenario (required) The value for the parameter scenario
Expand All @@ -509,6 +512,9 @@ public OrchestrationConfigPostResponse importOrchestrationConfig()
* @param resolveTemplateRef (optional, default to false) DEPRECATED: Use resolveTemplateRef
* instead
* @param resolveTemplateRef2 (optional) The value for the parameter resolveTemplateRef2
* @param $top (optional) Number of results to return (1–500). When omitted the full result set is
* returned (up to the server limit).
* @param $skip (optional, default to 0) Number of results to skip before returning the page.
* @return OrchestrationConfigListResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
Expand All @@ -521,7 +527,9 @@ public OrchestrationConfigListResponse listOrchestrationConfigHistory(
@Nullable final Boolean includeSpec,
@Nullable final Boolean includeSpec2,
@Nullable final Boolean resolveTemplateRef,
@Nullable final Boolean resolveTemplateRef2)
@Nullable final Boolean resolveTemplateRef2,
@Nullable final Integer $top,
@Nullable final Integer $skip)
throws OpenApiRequestException {

// verify the required parameter 'scenario' is set
Expand Down Expand Up @@ -569,6 +577,8 @@ public OrchestrationConfigListResponse listOrchestrationConfigHistory(
ApiClient.parameterToPair("resolve_template_ref", resolveTemplateRef));
localVarQueryParams.addAll(
ApiClient.parameterToPair("resolveTemplateRef", resolveTemplateRef2));
localVarQueryParams.addAll(ApiClient.parameterToPair("$top", $top));
localVarQueryParams.addAll(ApiClient.parameterToPair("$skip", $skip));
if (aiResourceGroup != null)
localVarHeaderParams.put("AI-Resource-Group", ApiClient.parameterToString(aiResourceGroup));

Expand Down Expand Up @@ -604,6 +614,9 @@ public OrchestrationConfigListResponse listOrchestrationConfigHistory(
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @param scenario The value for the parameter scenario
Expand All @@ -616,7 +629,8 @@ public OrchestrationConfigListResponse listOrchestrationConfigHistory(
public OrchestrationConfigListResponse listOrchestrationConfigHistory(
@Nonnull final String scenario, @Nonnull final String version, @Nonnull final String name)
throws OpenApiRequestException {
return listOrchestrationConfigHistory(scenario, version, name, null, null, null, null, null);
return listOrchestrationConfigHistory(
scenario, version, name, null, null, null, null, null, null, null);
}

/**
Expand All @@ -628,6 +642,9 @@ public OrchestrationConfigListResponse listOrchestrationConfigHistory(
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @param aiResourceGroup (optional) Specify a resource group id to use
Expand All @@ -640,6 +657,9 @@ public OrchestrationConfigListResponse listOrchestrationConfigHistory(
* @param resolveTemplateRef (optional, default to false) DEPRECATED: Use resolveTemplateRef
* instead
* @param resolveTemplateRef2 (optional) The value for the parameter resolveTemplateRef2
* @param $top (optional) Number of results to return (1–500). When omitted the full result set is
* returned (up to the server limit).
* @param $skip (optional, default to 0) Number of results to skip before returning the page.
* @return OrchestrationConfigListResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
Expand All @@ -653,7 +673,9 @@ public OrchestrationConfigListResponse listOrchestrationConfigs(
@Nullable final Boolean includeSpec,
@Nullable final Boolean includeSpec2,
@Nullable final Boolean resolveTemplateRef,
@Nullable final Boolean resolveTemplateRef2)
@Nullable final Boolean resolveTemplateRef2,
@Nullable final Integer $top,
@Nullable final Integer $skip)
throws OpenApiRequestException {

// create path and map variables
Expand All @@ -675,6 +697,8 @@ public OrchestrationConfigListResponse listOrchestrationConfigs(
ApiClient.parameterToPair("resolve_template_ref", resolveTemplateRef));
localVarQueryParams.addAll(
ApiClient.parameterToPair("resolveTemplateRef", resolveTemplateRef2));
localVarQueryParams.addAll(ApiClient.parameterToPair("$top", $top));
localVarQueryParams.addAll(ApiClient.parameterToPair("$skip", $skip));
if (aiResourceGroup != null)
localVarHeaderParams.put("AI-Resource-Group", ApiClient.parameterToString(aiResourceGroup));

Expand Down Expand Up @@ -710,13 +734,17 @@ public OrchestrationConfigListResponse listOrchestrationConfigs(
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @return OrchestrationConfigListResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public OrchestrationConfigListResponse listOrchestrationConfigs() throws OpenApiRequestException {
return listOrchestrationConfigs(null, null, null, null, null, null, null, null, null);
return listOrchestrationConfigs(
null, null, null, null, null, null, null, null, null, null, null);
}
}
34 changes: 30 additions & 4 deletions ...ompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/client/PromptTemplatesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,13 +516,19 @@ public PromptTemplatePostResponse importPromptTemplate() throws OpenApiRequestEx
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @param scenario (required) The value for the parameter scenario
* @param version (required) The value for the parameter version
* @param name (required) The value for the parameter name
* @param aiResourceGroup (optional) Specify a resource group id to use
* @param aiResourceGroupScope (optional) Specify whether the resource group scope is to be used
* @param $top (optional) Number of results to return (1–500). When omitted the full result set is
* returned (up to the server limit).
* @param $skip (optional, default to 0) Number of results to skip before returning the page.
* @return PromptTemplateListResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
Expand All @@ -532,7 +538,9 @@ public PromptTemplateListResponse listPromptTemplateHistory(
@Nonnull final String version,
@Nonnull final String name,
@Nullable final String aiResourceGroup,
@Nullable final String aiResourceGroupScope)
@Nullable final String aiResourceGroupScope,
@Nullable final Integer $top,
@Nullable final Integer $skip)
throws OpenApiRequestException {

// verify the required parameter 'scenario' is set
Expand Down Expand Up @@ -574,6 +582,8 @@ public PromptTemplateListResponse listPromptTemplateHistory(
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

localVarQueryParams.addAll(ApiClient.parameterToPair("$top", $top));
localVarQueryParams.addAll(ApiClient.parameterToPair("$skip", $skip));
if (aiResourceGroup != null)
localVarHeaderParams.put("AI-Resource-Group", ApiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
Expand Down Expand Up @@ -612,6 +622,9 @@ public PromptTemplateListResponse listPromptTemplateHistory(
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @param scenario The value for the parameter scenario
Expand All @@ -624,7 +637,7 @@ public PromptTemplateListResponse listPromptTemplateHistory(
public PromptTemplateListResponse listPromptTemplateHistory(
@Nonnull final String scenario, @Nonnull final String version, @Nonnull final String name)
throws OpenApiRequestException {
return listPromptTemplateHistory(scenario, version, name, null, null);
return listPromptTemplateHistory(scenario, version, name, null, null, null, null);
}

/**
Expand All @@ -636,6 +649,9 @@ public PromptTemplateListResponse listPromptTemplateHistory(
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @param aiResourceGroup (optional) Specify a resource group id to use
Expand All @@ -645,6 +661,9 @@ public PromptTemplateListResponse listPromptTemplateHistory(
* @param version (optional) The value for the parameter version
* @param retrieve (optional, default to both) The value for the parameter retrieve
* @param includeSpec (optional, default to false) The value for the parameter includeSpec
* @param $top (optional) Number of results to return (1–500). When omitted the full result set is
* returned (up to the server limit).
* @param $skip (optional, default to 0) Number of results to skip before returning the page.
* @return PromptTemplateListResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
Expand All @@ -656,7 +675,9 @@ public PromptTemplateListResponse listPromptTemplates(
@Nullable final String name,
@Nullable final String version,
@Nullable final String retrieve,
@Nullable final Boolean includeSpec)
@Nullable final Boolean includeSpec,
@Nullable final Integer $top,
@Nullable final Integer $skip)
throws OpenApiRequestException {

// create path and map variables
Expand All @@ -673,6 +694,8 @@ public PromptTemplateListResponse listPromptTemplates(
localVarQueryParams.addAll(ApiClient.parameterToPair("version", version));
localVarQueryParams.addAll(ApiClient.parameterToPair("retrieve", retrieve));
localVarQueryParams.addAll(ApiClient.parameterToPair("includeSpec", includeSpec));
localVarQueryParams.addAll(ApiClient.parameterToPair("$top", $top));
localVarQueryParams.addAll(ApiClient.parameterToPair("$skip", $skip));
if (aiResourceGroup != null)
localVarHeaderParams.put("AI-Resource-Group", ApiClient.parameterToString(aiResourceGroup));
if (aiResourceGroupScope != null)
Expand Down Expand Up @@ -711,14 +734,17 @@ public PromptTemplateListResponse listPromptTemplates(
*
* <p><b>403</b> - Forbidden Error
*
* <p><b>413</b> - Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip
* to paginate
*
* <p><b>0</b> - Common Error
*
* @return PromptTemplateListResponse
* @throws OpenApiRequestException if an error occurs while attempting to invoke the API
*/
@Nonnull
public PromptTemplateListResponse listPromptTemplates() throws OpenApiRequestException {
return listPromptTemplates(null, null, null, null, null, null, null);
return listPromptTemplates(null, null, null, null, null, null, null, null, null);
}

/**
Expand Down
60 changes: 60 additions & 0 deletions core-services/prompt-registry/src/main/resources/spec/prompt-registry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,16 @@ paths:
schema:
type: boolean
default: false
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
responses:
'200':
description: Successful response
headers:
Link:
description: Pagination links (rel=next, rel=prev)
schema:
type: string
content:
application/json:
schema:
Expand All @@ -80,6 +87,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/ForbiddenError'
'413':
$ref: '#/components/responses/PayloadTooLarge'
default:
$ref: '#/components/responses/CommonError'
/lm/scenarios/{scenario}/promptTemplates/{name}/versions/{version}/history:
Expand Down Expand Up @@ -107,9 +116,16 @@ paths:
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
responses:
'200':
description: Successful response
headers:
Link:
description: Pagination links (rel=next, rel=prev)
schema:
type: string
content:
application/json:
schema:
Expand All @@ -118,6 +134,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/ForbiddenError'
'413':
$ref: '#/components/responses/PayloadTooLarge'
default:
$ref: '#/components/responses/CommonError'
/lm/promptTemplates/{promptTemplateId}:
Expand Down Expand Up @@ -401,9 +419,16 @@ paths:
in: query
schema:
type: boolean
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
responses:
'200':
description: Successful response
headers:
Link:
description: Pagination links (rel=next, rel=prev)
schema:
type: string
content:
application/json:
schema:
Expand All @@ -412,6 +437,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/ForbiddenError'
'413':
$ref: '#/components/responses/PayloadTooLarge'
default:
$ref: '#/components/responses/CommonError'
/registry/v2/scenarios/{scenario}/orchestrationConfigs/{name}/versions/{version}/history:
Expand Down Expand Up @@ -460,9 +487,16 @@ paths:
in: query
schema:
type: boolean
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
responses:
'200':
description: Successful response
headers:
Link:
description: Pagination links (rel=next, rel=prev)
schema:
type: string
content:
application/json:
schema:
Expand All @@ -471,6 +505,8 @@ paths:
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/ForbiddenError'
'413':
$ref: '#/components/responses/PayloadTooLarge'
default:
$ref: '#/components/responses/CommonError'
/registry/v2/orchestrationConfigs/{orchestrationConfigId}:
Expand Down Expand Up @@ -2161,6 +2197,12 @@ components:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
PayloadTooLarge:
description: Payload Too Large — result set exceeds maximum allowed rows; use $top and $skip to paginate
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
parameters:
ai-resource-group:
name: AI-Resource-Group
Expand All @@ -2181,3 +2223,21 @@ components:
- 'True'
- 'false'
- 'False'
top:
name: $top
in: query
description: Number of results to return (1–500). When omitted the full result set is returned (up to the server limit).
required: false
schema:
type: integer
minimum: 1
maximum: 500
skip:
name: $skip
in: query
description: Number of results to skip before returning the page.
required: false
schema:
type: integer
minimum: 0
default: 0