fix(docs): update docs for SchemaField.label

datahub-project · Apr 9, 2024 · 3c22de9 · 3c22de9
1 parent 05c4e7b
commit 3c22de9
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/metadata-models/src/main/pegasus/com/linkedin/schema/SchemaField.pdl b/metadata-models/src/main/pegasus/com/linkedin/schema/SchemaField.pdl
@@ -46,12 +46,15 @@ record SchemaField {
    * Label of the field. Provides a more human-readable name for the field than field path. Some sources will
    * provide this metadata but not all sources have the concept of a label. If just one string is associated with
    * a field in a source, that is most likely a description.
+   *
+   * Note that this field is deprecated and is not surfaced in the UI.
    */
   @Searchable = {
     "fieldName": "fieldLabels",
     "fieldType": "TEXT",
     "boostScore": 0.2
   }
+  @Deprecated
   label: optional string
 
   /**