updated json schema and schema docs

catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json

@@ -15,11 +15,11 @@
       "type": "object",
       "properties": {
         "name": {
-          "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`",
+          "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`.",
           "type": "string"
         },
         "endpoint": {
-          "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`",
+          "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`.",
           "type": "string",
           "format": "uri"
         }

catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json

@@ -82,7 +82,7 @@
           "$ref": "#/definitions/fullyQualifiedFeatureSourceName"
         },
         "dataSource": {
-          "description": "Description of the Data Source (e.g., a Table)",
+          "description": "Description of the Data Source (e.g., a Table).",
           "$ref": "../../type/entityReference.json"
         },
         "tags": {

catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json

@@ -9,11 +9,7 @@
       "javaType": "org.openmetadata.catalog.type.StatusType",
       "description": "Enum defining the possible Status.",
       "type": "string",
-      "enum": [
-        "Successful",
-        "Failed",
-        "Pending"
-      ],
+      "enum": ["Successful", "Failed", "Pending"],
       "javaEnums": [
         {
           "name": "Successful"
@@ -108,7 +104,7 @@
           "$ref": "#/definitions/statusType"
         },
         "taskStatus": {
-          "description": "Series of task executions and its status",
+          "description": "Series of task executions and its status.",
           "type": "array",
           "items": {
             "$ref": "#/definitions/taskStatus"
@@ -180,7 +176,7 @@
       "default": null
     },
     "pipelineStatus": {
-      "description": "Series of pipeline executions and its status",
+      "description": "Series of pipeline executions and its status.",
       "type": "array",
       "items": {
         "$ref": "#/definitions/pipelineStatus"

catalog-rest-service/src/main/resources/json/schema/entity/data/table.json

@@ -107,7 +107,7 @@
       "maxLength": 128
     },
     "tableName": {
-      "description": "Local name (not fully qualified name) of a table. Dots will be escaped automatically",
+      "description": "Local name (not fully qualified name) of a table. Dots will be escaped automatically.",
       "type": "string",
       "minLength": 1,
       "maxLength": 128
@@ -633,4 +633,4 @@
   },
   "required": ["id", "name", "columns"],
   "additionalProperties": false
-}
+}

catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json

@@ -2,7 +2,7 @@
   "$id": "https://open-metadata.org/schema/entity/events/webhook.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Webhook",
-  "description": "This schema defines webhook for receiving events from OpenMetadata",
+  "description": "This schema defines webhook for receiving events from OpenMetadata.",
   "type": "object",
   "javaType": "org.openmetadata.catalog.type.Webhook",
   "properties": {

catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json

@@ -24,7 +24,7 @@
           "$ref": "../../type/basic.json#/definitions/timestamp"
         },
         "from": {
-          "description": "Name of the User posting the message",
+          "description": "Name of the User posting the message.",
           "type": "string"
         }
       },
@@ -70,16 +70,16 @@
       "type": "string"
     },
     "resolved": {
-      "description": "When `true` indicates the thread has been resolved",
+      "description": "When `true` indicates the thread has been resolved.",
       "type": "boolean",
       "default": false
     },
     "message": {
-      "description": "The main message of the thread in markdown format",
+      "description": "The main message of the thread in markdown format.",
       "type": "string"
     },
     "postsCount": {
-      "description": "The total count of posts in the thread",
+      "description": "The total count of posts in the thread.",
       "type": "integer",
       "default": 0
     },

catalog-rest-service/src/main/resources/json/schema/type/entityRelationship.json

@@ -82,7 +82,7 @@
       "minimum": 0
     },
     "relationshipType": {
-      "description": "Describes relationship between the two entities. Eg: Database --- Contains --> Table",
+      "description": "Describes relationship between the two entities. Eg: Database --- Contains --> Table.",
       "$ref": "#/definitions/relationshipType"
     },
     "deleted": {

catalog-rest-service/src/main/resources/json/schema/type/include.json

@@ -2,7 +2,7 @@
   "$id": "https://open-metadata.org/schema/type/include.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Include",
-  "description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include",
+  "description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include.",
   "type": "string",
   "javaType": "org.openmetadata.catalog.type.Include",
   "enum": ["all", "deleted", "non-deleted"],

docs/SUMMARY.md

@@ -70,6 +70,8 @@
     * [Delete Action](openmetadata-apis/schemas/entities/deleteaction.md)
     * [Feed](openmetadata-apis/schemas/entities/thread.md)
     * [Filters](openmetadata-apis/schemas/entities/filters.md)
+    * [Glossary](openmetadata-apis/schemas/entities/glossary.md)
+    * [Glossary Term](openmetadata-apis/schemas/entities/glossaryterm.md)
     * [Location](openmetadata-apis/schemas/entities/location.md)
     * [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md)
     * [Metrics](openmetadata-apis/schemas/entities/metrics.md)

docs/openmetadata-apis/schemas/entities/README.md

@@ -52,6 +52,14 @@ OpenMetadata has the following high-level core entities and relationships:
 [filters.md](filters.md)
 {% endcontent-ref %}
 
+{% content-ref url="glossary.md" %}
+[filters.md](glossary.md)
+{% endcontent-ref %}
+
+{% content-ref url="glossaryterm.md" %}
+[filters.md](glossaryterm.md)
+{% endcontent-ref %}
+
 {% content-ref url="location.md" %}
 [location.md](location.md)
 {% endcontent-ref %}

docs/openmetadata-apis/schemas/entities/accesscontrolrule.md

@@ -20,7 +20,7 @@ This schema <u>does not</u> accept additional properties.
 	 - $ref: [../../type/tagLabel.json#/definitions/tagFQN](../types/taglabel.md#tagfqn)
  - **userRoleAttr**
 	 - Role of the user that the rule should match on.
-	 - $ref: [../teams/team.json#/definitions/teamName](team.md#teamname)
+	 - $ref: [../teams/role.json#/definitions/roleName](role.md#rolename)
  - **operation**
 	 - Operation on the entity.
 	 - $ref: [#/definitions/operation](#operation)
@@ -50,7 +50,8 @@ This schema <u>does not</u> accept additional properties.
 	 4. _"UpdateOwner"_
 	 5. _"UpdateTags"_
 	 6. _"UpdateLineage"_
+	 7. _"DecryptTokens"_
+	 8. _"UpdateTeam"_
 
 
-
-_This document was updated on: Tuesday, January 25, 2022_
+_This document was updated on: Monday, March 7, 2022_

docs/openmetadata-apis/schemas/entities/bot.md

@@ -6,6 +6,8 @@ This schema defines Bot entity. A bot automates tasks, such as adding descriptio
 
 Type: `object`
 
+This schema <u>does not</u> accept additional properties.
+
 ## Properties
  - **id**
 	 - Unique identifier of a bot instance.
@@ -41,4 +43,4 @@ Type: `object`
 	 - Default: _false_
 
 
-_This document was updated on: Tuesday, January 25, 2022_
+_This document was updated on: Monday, March 7, 2022_

docs/openmetadata-apis/schemas/entities/chart.md

@@ -63,7 +63,7 @@ This schema <u>does not</u> accept additional properties.
 	 - $ref: [../../type/entityReference.json](../types/entityreference.md)
  - **serviceType**
 	 - Service type where this chart is hosted in.
-	 - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](../services/dashboardservice.md#dashboardservicetype)
+	 - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](dashboardservice.md#dashboardservicetype)
  - **usageSummary**
 	 - Latest usage information for this database.
 	 - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
@@ -93,4 +93,4 @@ This schema <u>does not</u> accept additional properties.
 	 9. _"BoxPlot"_
 	 10. _"Other"_
 
-_This document was updated on: Tuesday, January 25, 2022_
+_This document was updated on: Monday, March 7, 2022_

docs/openmetadata-apis/schemas/entities/dashboard.md

@@ -63,7 +63,7 @@ This schema <u>does not</u> accept additional properties.
 	 - $ref: [../../type/entityReference.json](../types/entityreference.md)
  - **serviceType**
 	 - Service type where this dashboard is hosted in.
-	 - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](../services/dashboardservice.md#dashboardservicetype)
+	 - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](dashboardservice.md#dashboardservicetype)
  - **usageSummary**
 	 - Latest usage information for this database.
 	 - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
@@ -76,4 +76,4 @@ This schema <u>does not</u> accept additional properties.
 	 - Default: _false_
 
 
-_This document was updated on: Tuesday, January 25, 2022_
+_This document was updated on: Monday, March 7, 2022_

docs/openmetadata-apis/schemas/entities/dashboardservice.md

@@ -15,6 +15,7 @@ This schema <u>does not</u> accept additional properties.
  - **name** `required`
 	 - Name that identifies this dashboard service.
 	 - Type: `string`
+	 - The value must match this pattern: `^[^.]*$`
 	 - Length: between 1 and 128
  - **displayName**
 	 - Display Name that identifies this dashboard service.
@@ -34,6 +35,9 @@ This schema <u>does not</u> accept additional properties.
  - **updatedBy**
 	 - User who made the update.
 	 - Type: `string`
+ - **owner**
+	 - Owner of this dashboard service.
+	 - $ref: [../../type/entityReference.json](../types/entityreference.md)
  - **dashboardUrl** `required`
 	 - Dashboard Service URL. This will be used to make REST API calls to Dashboard Service.
 	 - Type: `string`
@@ -70,8 +74,9 @@ This schema <u>does not</u> accept additional properties.
 	 3. _"Tableau"_
 	 4. _"Redash"_
 	 5. _"Metabase"_
+	 6. _"PowerBI"_
 
 
 
 
-_This document was updated on: Tuesday, January 25, 2022_
+_This document was updated on: Monday, March 7, 2022_

docs/openmetadata-apis/schemas/entities/database.md

@@ -44,7 +44,7 @@ This schema <u>does not</u> accept additional properties.
 	 - $ref: [../../type/entityReference.json](../types/entityreference.md)
  - **serviceType**
 	 - Service type where this database is hosted in.
-	 - $ref: [../services/databaseService.json#/definitions/databaseServiceType](../services/databaseservice.md#databaseservicetype)
+	 - $ref: [../services/databaseService.json#/definitions/databaseServiceType](databaseservice.md#databaseservicetype)
  - **location**
 	 - Reference to the Location that contains this database.
 	 - $ref: [../../type/entityReference.json](../types/entityreference.md)
@@ -68,10 +68,9 @@ This schema <u>does not</u> accept additional properties.
 
  - Name that identifies the database.
  - Type: `string`
- - The value must match this pattern: `^[^.]*$`
  - Length: between 1 and 128
 
 
 
 
-_This document was updated on: Tuesday, January 25, 2022_
+_This document was updated on: Monday, March 7, 2022_