openapi-directory/api/googleapis.com/essentialcontacts.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://essentialcontacts.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Essential Contacts API","version":"v1","x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"openapi","url":"https://essentialcontacts.googleapis.com/$discovery/rest?version=v1","version":"3.0"}],"x-providerName":"googleapis.com","x-serviceName":"essentialcontacts"},"externalDocs":{"url":"https://cloud.google.com/essentialcontacts/docs/"},"tags":[{"name":"folders"},{"name":"organizations"},{"name":"projects"}],"paths":{"/v1/{name}":{"delete":{"description":"Deletes a contact.","operationId":"essentialcontacts.projects.contacts.delete","parameters":[{"description":"Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleProtobufEmpty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets a single contact.","operationId":"essentialcontacts.projects.contacts.get","parameters":[{"description":"Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1Contact"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Updates a contact. Note: A contact's email address cannot be changed.","operationId":"essentialcontacts.projects.contacts.patch","parameters":[{"description":"Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1Contact"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1Contact"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/contacts":{"get":{"description":"Lists the contacts that have been set on a resource.","operationId":"essentialcontacts.projects.contacts.list","parameters":[{"description":"Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Adds a new contact for a resource.","operationId":"essentialcontacts.projects.contacts.create","parameters":[{"description":"Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1Contact"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1Contact"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/contacts:compute":{"get":{"description":"Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.","operationId":"essentialcontacts.projects.contacts.compute","parameters":[{"description":"Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.","explode":true,"in":"query","name":"notificationCategories","schema":{"items":{"enum":["NOTIFICATION_CATEGORY_UNSPECIFIED","ALL","SUSPENSION","SECURITY","TECHNICAL","BILLING","LEGAL","PRODUCT_UPDATES","TECHNICAL_INCIDENTS"],"type":"string"},"type":"array"},"style":"form"},{"description":"Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{resource}/contacts:sendTestMessage":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Allows a contact admin to send a test message to contact to verify that it has been configured correctly.","operationId":"essentialcontacts.projects.contacts.sendTestMessage","parameters":[{"description":"Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}","in":"path","name":"resource","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleProtobufEmpty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"GoogleCloudEssentialcontactsV1ComputeContactsResponse":{"description":"Response message for the ComputeContacts method.","properties":{"contacts":{"description":"All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.","items":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1Contact"},"type":"array"},"nextPageToken":{"description":"If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.","type":"string"}},"type":"object"},"GoogleCloudEssentialcontactsV1Contact":{"description":"A contact that will receive notifications from Google Cloud.","properties":{"email":{"description":"Required. The email address to send notifications to. The email address does not need to be a Google Account.","type":"string"},"languageTag":{"description":"Required. The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages.","type":"string"},"name":{"description":"Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}","readOnly":true,"type":"string"},"notificationCategorySubscriptions":{"description":"Required. The categories of notifications that the contact will receive communications for.","items":{"enum":["NOTIFICATION_CATEGORY_UNSPECIFIED","ALL","SUSPENSION","SECURITY","TECHNICAL","BILLING","LEGAL","PRODUCT_UPDATES","TECHNICAL_INCIDENTS"],"type":"string"},"type":"array"},"validateTime":{"description":"The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.","format":"google-datetime","type":"string"},"validationState":{"description":"The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.","enum":["VALIDATION_STATE_UNSPECIFIED","VALID","INVALID"],"type":"string"}},"type":"object"},"GoogleCloudEssentialcontactsV1ListContactsResponse":{"description":"Response message for the ListContacts method.","properties":{"contacts":{"description":"The contacts for the specified resource.","items":{"$ref":"#/components/schemas/GoogleCloudEssentialcontactsV1Contact"},"type":"array"},"nextPageToken":{"description":"If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request.","type":"string"}},"type":"object"},"GoogleCloudEssentialcontactsV1SendTestMessageRequest":{"description":"Request message for the SendTestMessage method.","properties":{"contacts":{"description":"Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}","items":{"type":"string"},"type":"array"},"notificationCategory":{"description":"Required. The notification category to send the test message for. All contacts must be subscribed to this category.","enum":["NOTIFICATION_CATEGORY_UNSPECIFIED","ALL","SUSPENSION","SECURITY","TECHNICAL","BILLING","LEGAL","PRODUCT_UPDATES","TECHNICAL_INCIDENTS"],"type":"string"}},"type":"object"},"GoogleProtobufEmpty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","properties":{},"type":"object"}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 implicit authentication","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/cloud-platform":"See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."}}},"type":"oauth2"},"Oauth2c":{"description":"Oauth 2.0 authorizationCode authentication","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/cloud-platform":"See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."},"tokenUrl":"https://accounts.google.com/o/oauth2/token"}},"type":"oauth2"}}}}