Appearance

Summarize a preview​

POST
/v1/previews/{org_uuid}/{preview_id}/summarize

Get a summary of a full Preview/PR of resources.
It summaries what are the overall changes of a review request.

Access

  • Members of the organization with a member role.
  • API key.

Authorizations​

apiKey

API key as username in Basic Authorization with
empty password.

TypeAPI Key (header: Authorization)
or
jwtToken
TypeHTTP (bearer)

Parameters​

Path Parameters

org_uuid*

UUID of the organization

Typestring
Required
format"uuid"
preview_id*

Unique identifier for the preview

Typeinteger
Required
Example42
format"int64"

Query Parameters

force

Force the request to avoid any cached content.

Typeboolean
Exampletrue

Responses​

OK

application/json
JSON
{
"summary": {
"contents": [
"string"
],
"created_at": "string",
"requester": {
"user_uuid": "683e0589-65a8-48b8-bd90-6ee89e0682ab",
"display_name": "Marius Tolzmann",
"user_picture_url": "https://lh3.googleusercontent.com/a/AAcHTtcBqudpP0hVoQyjDv-v5b4lP6e0vN_92zi_aPp90hE=s96-c"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI