Google Calendar Channels API

openapi: 3.1.0
info:
  title: Calendar API Channels API
  version: v3
  description: Generated from Google's published Discovery document for Calendar API (calendar v3, revision 20261109). 1 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
externalDocs:
  url: https://developers.google.com/workspace/calendar/firstapp
servers:
- url: https://www.googleapis.com
paths:
  /calendar/v3/channels/stop:
    post:
      operationId: calendar.channels.stop
      summary: Stop channels
      description: Stop watching resources through this channel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Channel'
      responses:
        '200':
          description: Successful response
        4XX:
          content: &id001
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id001
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/calendar
        - https://www.googleapis.com/auth/calendar.acls
        - https://www.googleapis.com/auth/calendar.acls.readonly
        - https://www.googleapis.com/auth/calendar.app.created
        - https://www.googleapis.com/auth/calendar.calendarlist
        - https://www.googleapis.com/auth/calendar.calendarlist.readonly
        - https://www.googleapis.com/auth/calendar.events
        - https://www.googleapis.com/auth/calendar.events.freebusy
        - https://www.googleapis.com/auth/calendar.events.owned
        - https://www.googleapis.com/auth/calendar.events.owned.readonly
        - https://www.googleapis.com/auth/calendar.events.public.readonly
        - https://www.googleapis.com/auth/calendar.events.readonly
        - https://www.googleapis.com/auth/calendar.readonly
        - https://www.googleapis.com/auth/calendar.settings
        - https://www.googleapis.com/auth/calendar.settings.readonly
      - apiKey: []
      tags:
      - Channels
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    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/calendar.acls: See and change the sharing permissions of Google calendars you
              own
            https://www.googleapis.com/auth/calendar: See, edit, share, and permanently delete all the calendars you can access
              using Google Calendar
            https://www.googleapis.com/auth/calendar.app.created: Make secondary Google calendars, and see, create, change,
              and delete events on them
            https://www.googleapis.com/auth/calendar.calendarlist: See, add, and remove Google calendars you’re subscribed
              to
            https://www.googleapis.com/auth/calendar.settings: View and edit your Calendar settings
            https://www.googleapis.com/auth/calendar.freebusy: View your availability in your calendars
            https://www.googleapis.com/auth/calendar.events.owned: See, create, change, and delete events on Google calendars
              you own
            https://www.googleapis.com/auth/calendar.events.owned.readonly: See the events on Google calendars you own
            https://www.googleapis.com/auth/calendar.events: View and edit events on all your calendars
            https://www.googleapis.com/auth/calendar.calendars.readonly: See the title, description, default time zone, and
              other properties of Google calendars you have access to
            https://www.googleapis.com/auth/calendar.calendarlist.readonly: See the list of Google calendars you’re subscribed
              to
            https://www.googleapis.com/auth/calendar.acls.readonly: See the sharing permissions of Google calendars you own
            https://www.googleapis.com/auth/calendar.calendars: See and change the properties of Google calendars you have
              access to, and create secondary calendars
            https://www.googleapis.com/auth/calendar.events.public.readonly: See the events on public calendars
            https://www.googleapis.com/auth/calendar.events.freebusy: See the availability on Google calendars you have access
              to
            https://www.googleapis.com/auth/calendar.events.readonly: View events on all your calendars
            https://www.googleapis.com/auth/calendar.readonly: See and download any calendar you can access using your Google
              Calendar
            https://www.googleapis.com/auth/calendar.settings.readonly: View your Calendar settings
  schemas:
    Channel:
      properties:
        resourceUri:
          description: A version-specific identifier for the watched resource.
          type: string
        params:
          description: Additional parameters controlling delivery channel behavior. Optional.
          additionalProperties:
            type: string
            description: Declares a new parameter by name.
          type: object
        kind:
          type: string
          description: Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
          default: api#channel
        type:
          type: string
          description: The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both
            values refer to a channel where Http requests are used to deliver messages.
        expiration:
          type: string
          format: int64
          description: Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
        token:
          description: An arbitrary string delivered to the target address with each notification delivered over this channel.
            Optional.
          type: string
        resourceId:
          type: string
          description: An opaque ID that identifies the resource being watched on this channel. Stable across different API
            versions.
        address:
          description: The address where notifications are delivered for this channel.
          type: string
        id:
          description: A UUID or similar unique string that identifies this channel.
          type: string
        payload:
          type: boolean
          description: A Boolean value to indicate whether payload is wanted. Optional.
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
x-provenance:
  method: harvested
  publisher: Google
  source: https://calendar-json.googleapis.com/$discovery/rest?version=v3
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261109)