Updates the search result summaries for a version of an OpenSearch application. The dryRun parameter is supported.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

PUT /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId]/summaries HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes "my_app_group_name"

The name of the application.

appId Integer Path Yes 10157886

The ID of the version.

dryRun Boolean Query No true

Specifies whether the request is a dry run.

Request body

Parameter

Type

Required

Example

Description

[]

Object

Yes

The settings of search result summaries.

For more information, see Summary.

[].field

String

Yes

"title"

The field for which you want to configure a search result summary.

[].len

Integer

Yes

50

The length of a search result summary.

[].element

String

Yes

"em"

The HTML tag that is used to highlight terms in red.

[].ellipsis

String

Yes

"..."

The connector that is used to connect segments.

[].snippet

Integer

Yes

1

The number of segments that are required in a search result summary.

Response parameters

Parameter Type Example Description
requestId String 7A389E09-7964-5A2B-FE9D-F6CFA7162852

The ID of the request.

result Boolean true

Indicates whether the operation was successful.

Examples

Sample requests

PUT /v4/openapi/app-groups/os_function_test_v1/apps/100299910/summaries?dryRun=true

[{
    "field": "title",
    "len": 50,
    "element": "em",
    "ellipsis": "...",
    "snippet": 1
}]

Sample success responses

XML format

<result>true</result>
<requestId>7A389E09-7964-5A2B-FE9D-F6CFA7162852</requestId>

JSON format

{
    "result": true,
    "requestId": "7A389E09-7964-5A2B-FE9D-F6CFA7162852"
}

Error codes

For a list of error codes, visit the API Error Center.