Clarify definition of AlleleDescription.label (#718)

Clarify definition of `AlleleDescription.label`
airr-community · Aug 27, 2023 · 81d2af8 · 81d2af8
1 parent d30beff
commit 81d2af8
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/lang/R/inst/extdata/airr-schema.yaml b/lang/R/inst/extdata/airr-schema.yaml
@@ -823,7 +823,10 @@ AlleleDescription:
                 miairr: important
         label:
             type: string
-            description: The accepted name for this gene or allele
+            description: >
+                The accepted name for this gene or allele following the relevant nomenclature.
+                The value in this field should correspond to values in acceptable name fields of other schemas, 
+                such as v_call, d_call, and j_call fields.
             example: IGHV1-69*01
             x-airr:
                 miairr: important

diff --git a/lang/python/airr/specs/airr-schema.yaml b/lang/python/airr/specs/airr-schema.yaml
@@ -823,7 +823,10 @@ AlleleDescription:
                 miairr: important
         label:
             type: string
-            description: The accepted name for this gene or allele
+            description: >
+                The accepted name for this gene or allele following the relevant nomenclature.
+                The value in this field should correspond to values in acceptable name fields of other schemas, 
+                such as v_call, d_call, and j_call fields.
             example: IGHV1-69*01
             x-airr:
                 miairr: important

diff --git a/specs/airr-schema-openapi3.yaml b/specs/airr-schema-openapi3.yaml
@@ -860,7 +860,10 @@ AlleleDescription:
             nullable: true
             x-airr:
                 miairr: important
-            description: The accepted name for this gene or allele
+            description: >
+                The accepted name for this gene or allele following the relevant nomenclature.
+                The value in this field should correspond to values in acceptable name fields of other schemas, 
+                such as v_call, d_call, and j_call fields.
             example: IGHV1-69*01
         sequence:
             type: string

diff --git a/specs/airr-schema.yaml b/specs/airr-schema.yaml
@@ -823,7 +823,10 @@ AlleleDescription:
                 miairr: important
         label:
             type: string
-            description: The accepted name for this gene or allele
+            description: >
+                The accepted name for this gene or allele following the relevant nomenclature.
+                The value in this field should correspond to values in acceptable name fields of other schemas, 
+                such as v_call, d_call, and j_call fields.
             example: IGHV1-69*01
             x-airr:
                 miairr: important