openapi: 3.1.0
info:
  title: Google Cloud Data Catalog Entries API
  description: The Data Catalog API provides a unified view of all data assets and enables metadata management, data discovery, and data governance across an organization. It allows programmatic creation and management of entries, tag templates, and policy tags.
  version: v1
  contact:
    name: Google Cloud
    url: https://cloud.google.com/data-catalog
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://datacatalog.googleapis.com/v1
  description: Google Cloud Data Catalog API v1
security:
- oauth2: []
tags:
- name: Entries
  description: Operations for managing catalog entries
paths:
  /projects/{projectId}/locations/{location}/entryGroups/{entryGroupId}/entries:
    get:
      operationId: listEntries
      summary: Google Cloud Data Catalog List entries
      description: Lists entries in an entry group.
      tags:
      - Entries
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: location
        in: path
        required: true
        schema:
          type: string
      - name: entryGroupId
        in: path
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        schema:
          type: integer
      - name: pageToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEntriesResponse'
    post:
      operationId: createEntry
      summary: Google Cloud Data Catalog Create an entry
      description: Creates an entry in the specified entry group.
      tags:
      - Entries
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: location
        in: path
        required: true
        schema:
          type: string
      - name: entryGroupId
        in: path
        required: true
        schema:
          type: string
      - name: entryId
        in: query
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Entry'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entry'
  /projects/{projectId}/locations/{location}/entryGroups/{entryGroupId}/entries/{entryId}:
    get:
      operationId: getEntry
      summary: Google Cloud Data Catalog Get an entry
      description: Gets an entry by its resource name.
      tags:
      - Entries
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: location
        in: path
        required: true
        schema:
          type: string
      - name: entryGroupId
        in: path
        required: true
        schema:
          type: string
      - name: entryId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entry'
    patch:
      operationId: updateEntry
      summary: Google Cloud Data Catalog Update an entry
      description: Updates an existing entry.
      tags:
      - Entries
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: location
        in: path
        required: true
        schema:
          type: string
      - name: entryGroupId
        in: path
        required: true
        schema:
          type: string
      - name: entryId
        in: path
        required: true
        schema:
          type: string
      - name: updateMask
        in: query
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Entry'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entry'
    delete:
      operationId: deleteEntry
      summary: Google Cloud Data Catalog Delete an entry
      description: Deletes an existing entry.
      tags:
      - Entries
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: location
        in: path
        required: true
        schema:
          type: string
      - name: entryGroupId
        in: path
        required: true
        schema:
          type: string
      - name: entryId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
components:
  schemas:
    Entry:
      type: object
      properties:
        name:
          type: string
          description: Output only. The resource name of the entry.
        linkedResource:
          type: string
          description: The resource this metadata entry refers to.
        fullyQualifiedName:
          type: string
          description: Fully qualified name of the resource.
        type:
          type: string
          enum:
          - ENTRY_TYPE_UNSPECIFIED
          - TABLE
          - MODEL
          - DATA_STREAM
          - FILESET
          - CLUSTER
          - DATABASE
          - DATA_SOURCE_CONNECTION
          - ROUTINE
          - LAKE
          - ZONE
          - SERVICE
          description: The type of the entry.
        displayName:
          type: string
          description: Display name of the entry.
        description:
          type: string
          description: Entry description.
        schema:
          type: object
          properties:
            columns:
              type: array
              items:
                type: object
                properties:
                  column:
                    type: string
                  type:
                    type: string
                  description:
                    type: string
                  mode:
                    type: string
        sourceSystemTimestamps:
          type: object
          properties:
            createTime:
              type: string
              format: date-time
            updateTime:
              type: string
              format: date-time
            expireTime:
              type: string
              format: date-time
        integratedSystem:
          type: string
          description: Output only. The source system of the entry.
        userSpecifiedSystem:
          type: string
          description: Custom source system that user specified.
    ListEntriesResponse:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/Entry'
        nextPageToken:
          type: string
  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: Full access to Google Cloud Platform
externalDocs:
  description: Google Cloud Data Catalog Documentation
  url: https://cloud.google.com/data-catalog/docs/reference/rest