Skip to content

Latest commit

 

History

History
120 lines (74 loc) · 3.04 KB

common-definitions-entityreference.md

File metadata and controls

120 lines (74 loc) · 3.04 KB
layout title
default
Common-Definitions-Entityreference

common-definitions-entityreference

Untitled object in Table entity Schema

https://github.com/StreamlineData/catalog/blob/master/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json#/properties/owner

Owner of this entity

Entity reference that includes entity ID and entity type

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none createTable.json*

owner Type

object (Details)

owner Properties

Property Type Required Nullable Defined by
id string Required cannot be null Common types
type string Required cannot be null Common types
name string Optional cannot be null Common types
description string Optional cannot be null Common types
href string Optional cannot be null Common types

id

Unique id used to identify an entity

id

  • is required
  • Type: string
  • cannot be null
  • defined in: Common types

id Type

string

id Constraints

UUID: the string must be a UUID, according to RFC 4122

type

Entity type/class name - Examples: database, table, metrics, redshift, mysql, bigquery, snowflake...

type

  • is required
  • Type: string
  • cannot be null
  • defined in: Common types

type Type

string

name

Name of the entity instance

name

  • is optional
  • Type: string
  • cannot be null
  • defined in: Common types

name Type

string

description

Optional description of entity

description

  • is optional
  • Type: string
  • cannot be null
  • defined in: Common types

description Type

string

href

Link to the entity resource

Link to the resource

href

  • is optional
  • Type: string
  • cannot be null
  • defined in: Common types

href Type

string

href Constraints

URI: the string must be a URI, according to RFC 3986