diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 9f8d3285ca3..6542afe48e2 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -8665,6 +8665,82 @@ menu: unstable: - v2 order: 0 + - name: Google Chat Integration + url: /api/latest/google-chat-integration/ + identifier: google-chat-integration + generated: true + - name: Update organization handle + url: '#update-organization-handle' + identifier: google-chat-integration-update-organization-handle + parent: google-chat-integration + generated: true + params: + versions: + - v2 + operationids: + - UpdateOrganizationHandle + unstable: [] + order: 1 + - name: Get organization handle + url: '#get-organization-handle' + identifier: google-chat-integration-get-organization-handle + parent: google-chat-integration + generated: true + params: + versions: + - v2 + operationids: + - GetOrganizationHandle + unstable: [] + order: 1 + - name: Delete organization handle + url: '#delete-organization-handle' + identifier: google-chat-integration-delete-organization-handle + parent: google-chat-integration + generated: true + params: + versions: + - v2 + operationids: + - DeleteOrganizationHandle + unstable: [] + order: 1 + - name: Create organization handle + url: '#create-organization-handle' + identifier: google-chat-integration-create-organization-handle + parent: google-chat-integration + generated: true + params: + versions: + - v2 + operationids: + - CreateOrganizationHandle + unstable: [] + order: 1 + - name: Get all organization handles + url: '#get-all-organization-handles' + identifier: google-chat-integration-get-all-organization-handles + parent: google-chat-integration + generated: true + params: + versions: + - v2 + operationids: + - ListOrganizationHandles + unstable: [] + order: 1 + - name: Get space information by display name + url: '#get-space-information-by-display-name' + identifier: google-chat-integration-get-space-information-by-display-name + parent: google-chat-integration + generated: true + params: + versions: + - v2 + operationids: + - GetSpaceByDisplayName + unstable: [] + order: 1 - name: High Availability MultiRegion url: /api/latest/high-availability-multiregion/ identifier: high-availability-multiregion diff --git a/content/en/api/latest/google-chat-integration/_index.md b/content/en/api/latest/google-chat-integration/_index.md new file mode 100644 index 00000000000..ffcd4893f20 --- /dev/null +++ b/content/en/api/latest/google-chat-integration/_index.md @@ -0,0 +1,3 @@ +--- +title: Google Chat Integration +--- diff --git a/content/en/api/v2/google-chat-integration/_index.md b/content/en/api/v2/google-chat-integration/_index.md new file mode 100644 index 00000000000..ccfbc642322 --- /dev/null +++ b/content/en/api/v2/google-chat-integration/_index.md @@ -0,0 +1,4 @@ +--- +title: Google Chat Integration +headless: true +--- diff --git a/content/en/api/v2/google-chat-integration/examples.json b/content/en/api/v2/google-chat-integration/examples.json new file mode 100644 index 00000000000..f8cc7c1ae2c --- /dev/null +++ b/content/en/api/v2/google-chat-integration/examples.json @@ -0,0 +1,358 @@ +{ + "GetSpaceByDisplayName": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "display_name": "Fake Space Name", + "organization_binding_id": "2f18a894-adb5-4c53-8248-39fd3f5386a5", + "resource_name": "spaces/AAAAAAAAA", + "space_uri": "https://chat.google.com/room/AAAAAAAAA" + }, + "id": "596da4af-0563-4097-90ff-07230c3f9db3", + "type": "google-chat-app-named-space" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Google Chat space data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Google Chat space attributes.

\n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Google space display name.

\n
\n \n
\n
\n
\n
\n
\n

organization_binding_id

\n
\n

string

\n

Organization binding ID.

\n
\n \n
\n
\n
\n
\n
\n

resource_name

\n
\n

string

\n

Google space resource name.

\n
\n \n
\n
\n
\n
\n
\n

space_uri

\n
\n

string

\n

Google space URI.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Google Chat space.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Google Chat space resource type. \nAllowed enum values: google-chat-app-named-space

default: google-chat-app-named-space

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "ListOrganizationHandles": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "name": "fake-handle-name", + "space_display_name": "Fake Space Name", + "space_resource_name": "spaces/AAAAAAAAA" + }, + "id": "596da4af-0563-4097-90ff-07230c3f9db3", + "type": "google-chat-organization-handle" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of organization handles.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Organization handle attributes.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Organization handle name.

\n
\n \n
\n
\n
\n
\n
\n

space_display_name

\n
\n

string

\n

Google space display name.

\n
\n \n
\n
\n
\n
\n
\n

space_resource_name

\n
\n

string

\n

Google space resource name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the organization handle.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Organization handle resource type. \nAllowed enum values: google-chat-organization-handle

default: google-chat-organization-handle

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateOrganizationHandle": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "name": "fake-handle-name", + "space_display_name": "Fake Space Name", + "space_resource_name": "spaces/AAAAAAAAA" + }, + "id": "596da4af-0563-4097-90ff-07230c3f9db3", + "type": "google-chat-organization-handle" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Organization handle data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Organization handle attributes.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Organization handle name.

\n
\n \n
\n
\n
\n
\n
\n

space_display_name

\n
\n

string

\n

Google space display name.

\n
\n \n
\n
\n
\n
\n
\n

space_resource_name

\n
\n

string

\n

Google space resource name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the organization handle.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Organization handle resource type. \nAllowed enum values: google-chat-organization-handle

default: google-chat-organization-handle

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "409": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "name": "fake-handle-name", + "space_resource_name": "spaces/AAAAAAAAA" + } + }, + "type": "google-chat-organization-handle" + }, + "json": { + "data": { + "attributes": { + "name": "fake-handle-name", + "space_resource_name": "spaces/AAAAAAAAA" + } + }, + "type": "google-chat-organization-handle" + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Organization handle data for a create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Organization handle attributes for a create request.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Organization handle name.

\n
\n \n
\n
\n
\n
\n
\n

space_resource_name [required]

\n
\n

string

\n

Google space resource name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organization handle resource type. \nAllowed enum values: google-chat-organization-handle

default: google-chat-organization-handle

\n
\n \n
\n
" + } + }, + "DeleteOrganizationHandle": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetOrganizationHandle": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "name": "fake-handle-name", + "space_display_name": "Fake Space Name", + "space_resource_name": "spaces/AAAAAAAAA" + }, + "id": "596da4af-0563-4097-90ff-07230c3f9db3", + "type": "google-chat-organization-handle" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Organization handle data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Organization handle attributes.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Organization handle name.

\n
\n \n
\n
\n
\n
\n
\n

space_display_name

\n
\n

string

\n

Google space display name.

\n
\n \n
\n
\n
\n
\n
\n

space_resource_name

\n
\n

string

\n

Google space resource name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the organization handle.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Organization handle resource type. \nAllowed enum values: google-chat-organization-handle

default: google-chat-organization-handle

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateOrganizationHandle": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "name": "fake-handle-name", + "space_display_name": "Fake Space Name", + "space_resource_name": "spaces/AAAAAAAAA" + }, + "id": "596da4af-0563-4097-90ff-07230c3f9db3", + "type": "google-chat-organization-handle" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Organization handle data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Organization handle attributes.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Organization handle name.

\n
\n \n
\n
\n
\n
\n
\n

space_display_name

\n
\n

string

\n

Google space display name.

\n
\n \n
\n
\n
\n
\n
\n

space_resource_name

\n
\n

string

\n

Google space resource name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the organization handle.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Organization handle resource type. \nAllowed enum values: google-chat-organization-handle

default: google-chat-organization-handle

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "409": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": {} + }, + "type": "google-chat-organization-handle" + }, + "json": { + "data": { + "attributes": { + "name": "fake-handle-name", + "space_resource_name": "spaces/AAAAAAAAA" + } + }, + "type": "google-chat-organization-handle" + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Organization handle data for an update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Organization handle attributes for an update request.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Organization handle name.

\n
\n \n
\n
\n
\n
\n
\n

space_resource_name

\n
\n

string

\n

Google space resource name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organization handle resource type. \nAllowed enum values: google-chat-organization-handle

default: google-chat-organization-handle

\n
\n \n
\n
" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/google-chat-integration/request.CreateOrganizationHandle.json b/content/en/api/v2/google-chat-integration/request.CreateOrganizationHandle.json new file mode 100644 index 00000000000..f0a6fe40327 --- /dev/null +++ b/content/en/api/v2/google-chat-integration/request.CreateOrganizationHandle.json @@ -0,0 +1,9 @@ +{ + "data": { + "attributes": { + "name": "Example-Google-Chat-Integration", + "space_resource_name": "spaces/AAQA-zFIks8" + } + }, + "type": "google-chat-organization-handle" +} \ No newline at end of file diff --git a/content/en/api/v2/google-chat-integration/request.UpdateOrganizationHandle.json b/content/en/api/v2/google-chat-integration/request.UpdateOrganizationHandle.json new file mode 100644 index 00000000000..865f0fe3720 --- /dev/null +++ b/content/en/api/v2/google-chat-integration/request.UpdateOrganizationHandle.json @@ -0,0 +1,8 @@ +{ + "data": { + "attributes": { + "name": "fake-handle-name--updated" + } + }, + "type": "google-chat-organization-handle" +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index f5801b49ea7..21ab5d6d7ff 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -758,6 +758,20 @@ "description": "Update STS Service Account returns \"OK\" response with enable resource collection turned on" } ], + "CreateOrganizationHandle": [ + { + "group": "google_chat_integration", + "suffix": "", + "description": "Create organization handle returns \"CREATED\" response" + } + ], + "UpdateOrganizationHandle": [ + { + "group": "google_chat_integration", + "suffix": "", + "description": "Update organization handle returns \"OK\" response" + } + ], "UpdateIPAllowlist": [ { "group": "ip_allowlist", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index b22b3d5a1f8..c9849ac224f 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -510,6 +510,34 @@ components: items: $ref: '#/components/schemas/GetIssueIncludeQueryParameterItem' type: array + GoogleChatHandleIdPathParameter: + description: Your organization handle ID. + in: path + name: handle_id + required: true + schema: + type: string + GoogleChatOrganizationBindingIdPathParameter: + description: Your organization binding ID. + in: path + name: organization_binding_id + required: true + schema: + type: string + GoogleChatOrganizationDomainNamePathParameter: + description: The Google Chat domain name. + in: path + name: domain_name + required: true + schema: + type: string + GoogleChatOrganizationSpaceDisplayNamePathParameter: + description: The Google Chat space display name. + in: path + name: space_display_name + required: true + schema: + type: string IncidentIDPathParameter: description: The UUID of the incident. in: path @@ -28487,6 +28515,206 @@ components: type: string x-enum-varnames: - GLOBAL_VARIABLES + GoogleChatAppNamedSpaceResponse: + description: Response with Google Chat space information. + properties: + data: + $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponseData' + required: + - data + type: object + GoogleChatAppNamedSpaceResponseAttributes: + description: Google Chat space attributes. + properties: + display_name: + description: Google space display name. + example: Fake Space Name + maxLength: 255 + type: string + organization_binding_id: + description: Organization binding ID. + example: 2f18a894-adb5-4c53-8248-39fd3f5386a5 + maxLength: 255 + type: string + resource_name: + description: Google space resource name. + example: spaces/AAAAAAAAA + maxLength: 255 + type: string + space_uri: + description: Google space URI. + example: https://chat.google.com/room/AAAAAAAAA + maxLength: 255 + type: string + type: object + GoogleChatAppNamedSpaceResponseData: + description: Google Chat space data from a response. + properties: + attributes: + $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponseAttributes' + id: + description: The ID of the Google Chat space. + example: 596da4af-0563-4097-90ff-07230c3f9db3 + maxLength: 100 + minLength: 1 + type: string + type: + $ref: '#/components/schemas/GoogleChatAppNamedSpaceType' + type: object + GoogleChatAppNamedSpaceType: + default: google-chat-app-named-space + description: Google Chat space resource type. + enum: + - google-chat-app-named-space + example: google-chat-app-named-space + type: string + x-enum-varnames: + - GOOGLE_CHAT_APP_NAMED_SPACE_TYPE + GoogleChatCreateOrganizationHandleRequest: + description: Create organization handle request. + properties: + data: + $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequestData' + type: + $ref: '#/components/schemas/GoogleChatOrganizationHandleType' + required: + - type + - data + type: object + GoogleChatCreateOrganizationHandleRequestAttributes: + description: Organization handle attributes for a create request. + properties: + name: + description: Organization handle name. + example: fake-handle-name + maxLength: 255 + type: string + space_resource_name: + description: Google space resource name. + example: spaces/AAAAAAAAA + maxLength: 255 + type: string + required: + - name + - space_resource_name + type: object + GoogleChatCreateOrganizationHandleRequestData: + description: Organization handle data for a create request. + properties: + attributes: + $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequestAttributes' + required: + - attributes + type: object + GoogleChatOrganizationHandleResponse: + description: Organization handle for monitor notifications to a Google Chat + space within a Google organization. + properties: + data: + $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseData' + required: + - data + type: object + GoogleChatOrganizationHandleResponseAttributes: + description: Organization handle attributes. + properties: + name: + description: Organization handle name. + example: fake-handle-name + maxLength: 255 + type: string + space_display_name: + description: Google space display name. + example: Fake Space Name + maxLength: 255 + type: string + space_resource_name: + description: Google space resource name. + example: spaces/AAAAAAAAA + maxLength: 255 + type: string + type: object + GoogleChatOrganizationHandleResponseData: + description: Organization handle data from a response. + properties: + attributes: + $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseAttributes' + id: + description: The ID of the organization handle. + example: 596da4af-0563-4097-90ff-07230c3f9db3 + maxLength: 100 + minLength: 1 + type: string + type: + $ref: '#/components/schemas/GoogleChatOrganizationHandleType' + type: object + GoogleChatOrganizationHandleType: + default: google-chat-organization-handle + description: Organization handle resource type. + enum: + - google-chat-organization-handle + example: google-chat-organization-handle + type: string + x-enum-varnames: + - GOOGLE_CHAT_ORGANIZATION_HANDLE_TYPE + GoogleChatOrganizationHandlesResponse: + description: List of organization handles for monitor notifications to Google + Chat spaces within a Google organization. + properties: + data: + description: An array of organization handles. + example: + - attributes: + name: general-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: 596da4af-0563-4097-90ff-07230c3f9db3 + type: google-chat-organization-handle + - attributes: + name: general-handle-2 + space_display_name: General2 + space_resource_name: spaces/BBBBBBBBB + id: 596da4af-0563-4097-90ff-07230c3f9db4 + type: google-chat-organization-handle + items: + $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseData' + type: array + required: + - data + type: object + GoogleChatUpdateOrganizationHandleRequest: + description: Update organization handle request. + properties: + data: + $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequestData' + type: + $ref: '#/components/schemas/GoogleChatOrganizationHandleType' + required: + - type + - data + type: object + GoogleChatUpdateOrganizationHandleRequestAttributes: + description: Organization handle attributes for an update request. + properties: + name: + description: Organization handle name. + example: fake-handle-name + maxLength: 255 + type: string + space_resource_name: + description: Google space resource name. + example: spaces/AAAAAAAAA + maxLength: 255 + type: string + type: object + GoogleChatUpdateOrganizationHandleRequestData: + description: Organization handle data for an update request. + properties: + attributes: + $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequestAttributes' + required: + - attributes + type: object GoogleMeetConfigurationReference: description: A reference to a Google Meet Configuration resource. nullable: true @@ -83517,6 +83745,183 @@ paths: operator: OR permissions: - gcp_configuration_edit + /api/v2/integration/google-chat/organizations/app/named-spaces/{domain_name}/{space_display_name}: + get: + description: Get the resource name and organization binding ID of a space in + the Datadog Google Chat integration. + operationId: GetSpaceByDisplayName + parameters: + - $ref: '#/components/parameters/GoogleChatOrganizationDomainNamePathParameter' + - $ref: '#/components/parameters/GoogleChatOrganizationSpaceDisplayNamePathParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get space information by display name + tags: + - Google Chat Integration + x-menu-order: 1 + /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles: + get: + description: Get a list of all organization handles from the Datadog Google + Chat integration. + operationId: ListOrganizationHandles + parameters: + - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleChatOrganizationHandlesResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get all organization handles + tags: + - Google Chat Integration + x-menu-order: 1 + post: + description: Create an organization handle in the Datadog Google Chat integration. + operationId: CreateOrganizationHandle + parameters: + - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequest' + description: Organization handle payload. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse' + description: CREATED + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create organization handle + tags: + - Google Chat Integration + x-codegen-request-body-name: body + x-menu-order: 1 + /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}: + delete: + description: Delete an organization handle from the Datadog Google Chat integration. + operationId: DeleteOrganizationHandle + parameters: + - description: Your organization binding ID. + in: path + name: organization_binding_id + required: true + schema: + type: string + - description: Your organization handle ID. + in: path + name: handle_id + required: true + schema: + type: string + responses: + '204': + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete organization handle + tags: + - Google Chat Integration + x-menu-order: 1 + get: + description: Get an organization handle from the Datadog Google Chat integration. + operationId: GetOrganizationHandle + parameters: + - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' + - $ref: '#/components/parameters/GoogleChatHandleIdPathParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get organization handle + tags: + - Google Chat Integration + x-menu-order: 1 + patch: + description: Update an organization handle from the Datadog Google Chat integration. + operationId: UpdateOrganizationHandle + parameters: + - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' + - $ref: '#/components/parameters/GoogleChatHandleIdPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequest' + description: Organization handle payload. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update organization handle + tags: + - Google Chat Integration + x-codegen-request-body-name: body + x-menu-order: 1 /api/v2/integration/jira/accounts: get: description: Get all Jira accounts for the organization. @@ -107829,6 +108234,14 @@ tags: externalDocs: url: https://docs.datadoghq.com/integrations/google_cloud_platform name: GCP Integration +- description: 'Configure your [Datadog Google Chat integration](https://docs.datadoghq.com/integrations/google-hangouts-chat/) + + directly through the Datadog API.' + externalDocs: + description: For more information about the Datadog Google Chat integration, see + the integration page. + url: https://docs.datadoghq.com/integrations/google-hangouts-chat/ + name: Google Chat Integration - description: 'Configure High Availability Multi-Region (HAMR) connections between Datadog organizations. diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index d35265f57f4..d94732bc7db 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1560,6 +1560,34 @@ "request_description": "Create a delegate service account within Datadog.", "request_schema_description": "" }, + "GetSpaceByDisplayName": { + "description": "Get the resource name and organization binding ID of a space in the Datadog Google Chat integration.", + "summary": "Get space information by display name" + }, + "ListOrganizationHandles": { + "description": "Get a list of all organization handles from the Datadog Google Chat integration.", + "summary": "Get all organization handles" + }, + "CreateOrganizationHandle": { + "description": "Create an organization handle in the Datadog Google Chat integration.", + "summary": "Create organization handle", + "request_description": "Organization handle payload.", + "request_schema_description": "Create organization handle request." + }, + "DeleteOrganizationHandle": { + "description": "Delete an organization handle from the Datadog Google Chat integration.", + "summary": "Delete organization handle" + }, + "GetOrganizationHandle": { + "description": "Get an organization handle from the Datadog Google Chat integration.", + "summary": "Get organization handle" + }, + "UpdateOrganizationHandle": { + "description": "Update an organization handle from the Datadog Google Chat integration.", + "summary": "Update organization handle", + "request_description": "Organization handle payload.", + "request_schema_description": "Update organization handle request." + }, "ListJiraAccounts": { "description": "Get all Jira accounts for the organization.", "summary": "List Jira accounts" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index f4a9e800c44..65f9b0e075a 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -163,6 +163,10 @@ "name": "GCP Integration", "description": "Configure your Datadog-Google Cloud Platform (GCP) integration directly\nthrough the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform)." }, + "google-chat-integration": { + "name": "Google Chat Integration", + "description": "Configure your [Datadog Google Chat integration](https://docs.datadoghq.com/integrations/google-hangouts-chat/)\ndirectly through the Datadog API." + }, "high-availability-multiregion": { "name": "High Availability MultiRegion", "description": "Configure High Availability Multi-Region (HAMR) connections between Datadog organizations.\nHAMR provides disaster recovery capabilities by maintaining synchronized data between primary\nand secondary organizations across different datacenters."