Google Cloud Storage Notifications API

openapi: 3.2.0
info:
  title: Cloud Storage JSON Notifications API
  description: Stores and retrieves potentially large, immutable data objects.
  version: v1
  x-discovery-revision: '20261030'
  termsOfService: https://developers.google.com/terms/
  contact:
    name: Google Cloud Storage
    url: https://developers.google.com/storage/docs/json_api/
  x-generated-from: google-discovery
  x-source: https://storage.googleapis.com/$discovery/rest?version=v1
  x-conversion: mechanical Discovery-to-OpenAPI conversion by API Evangelist; every path, parameter and schema is copied from the provider Discovery document
servers:
- url: https://storage.googleapis.com
security:
- oauth2:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/cloud-platform.read-only
  - https://www.googleapis.com/auth/devstorage.full_control
  - https://www.googleapis.com/auth/devstorage.read_only
  - https://www.googleapis.com/auth/devstorage.read_write
tags:
- name: Notifications
paths:
  /storage/v1/b/{bucket}/notificationConfigs/{notification}:
    delete:
      operationId: storage.notifications.delete
      tags:
      - Notifications
      summary: Permanently deletes a notification subscription
      description: Permanently deletes a notification subscription.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: The parent bucket of the notification.
      - name: notification
        in: path
        required: true
        schema:
          type: string
        description: ID of the notification to delete.
      - name: userProject
        in: query
        required: false
        schema:
          type: string
        description: The project to be billed for this request. Required for Requester Pays buckets.
      responses:
        '200':
          description: Successful response
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_write
    get:
      operationId: storage.notifications.get
      tags:
      - Notifications
      summary: View a notification configuration
      description: View a notification configuration.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: The parent bucket of the notification.
      - name: notification
        in: path
        required: true
        schema:
          type: string
        description: Notification ID
      - name: userProject
        in: query
        required: false
        schema:
          type: string
        description: The project to be billed for this request. Required for Requester Pays buckets.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/cloud-platform.read-only
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_only
        - https://www.googleapis.com/auth/devstorage.read_write
  /storage/v1/b/{bucket}/notificationConfigs:
    post:
      operationId: storage.notifications.insert
      tags:
      - Notifications
      summary: Creates a notification subscription for a given bucket
      description: Creates a notification subscription for a given bucket.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: The parent bucket of the notification.
      - name: userProject
        in: query
        required: false
        schema:
          type: string
        description: The project to be billed for this request. Required for Requester Pays buckets.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Notification'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_write
    get:
      operationId: storage.notifications.list
      tags:
      - Notifications
      summary: Retrieves a list of notification subscriptions for a given bucket
      description: Retrieves a list of notification subscriptions for a given bucket.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of a Google Cloud Storage bucket.
      - name: userProject
        in: query
        required: false
        schema:
          type: string
        description: The project to be billed for this request. Required for Requester Pays buckets.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notifications'
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/cloud-platform.read-only
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_only
        - https://www.googleapis.com/auth/devstorage.read_write
components:
  schemas:
    Notifications:
      type: object
      description: A list of notification subscriptions.
      properties:
        items:
          type: array
          description: The list of items.
          items:
            $ref: '#/components/schemas/Notification'
        kind:
          type: string
          description: The kind of item this is. For lists of notifications, this is always storage#notifications.
          default: storage#notifications
    Notification:
      type: object
      description: A subscription to receive Google PubSub notifications.
      properties:
        custom_attributes:
          type: object
          description: An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.
          additionalProperties:
            type: string
        etag:
          type: string
          description: HTTP 1.1 Entity tag for this subscription notification.
        event_types:
          type: array
          description: If present, only send notifications about listed event types. If empty, sent notifications for all event types.
          items:
            type: string
        id:
          type: string
          description: The ID of the notification.
        kind:
          type: string
          description: The kind of item this is. For notifications, this is always storage#notification.
          default: storage#notification
        object_name_prefix:
          type: string
          description: If present, only apply this notification configuration to object names that begin with this prefix.
        payload_format:
          type: string
          description: The desired content of the Payload.
          default: JSON_API_V1
        selfLink:
          type: string
          description: The canonical URL of this notification.
        topic:
          type: string
          description: 'The Cloud PubSub topic to which this subscription publishes. Formatted as: ''//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'''
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services
            https://www.googleapis.com/auth/cloud-platform.read-only: View your data across Google Cloud Platform services
            https://www.googleapis.com/auth/devstorage.full_control: Manage your data and permissions in Google Cloud Storage
            https://www.googleapis.com/auth/devstorage.read_only: View your data in Google Cloud Storage
            https://www.googleapis.com/auth/devstorage.read_write: Manage your data in Google Cloud Storage