define object for repertoires array

airr-community · Nov 26, 2024 · 3b4bf86 · 3b4bf86
1 parent f52ea07
commit 3b4bf86
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 40 deletions.
diff --git a/specs/airr-schema-openapi3.yaml b/specs/airr-schema-openapi3.yaml
@@ -3245,6 +3245,28 @@ Repertoire:
                 adc-query-support: true
 
 # A collection of repertoires for analysis purposes, includes optional time course
+RepertoireGroupDetail:
+    type: object
+    properties:
+        repertoire_id:
+            type: string
+            nullable: false
+            description: Identifier to the repertoire
+            x-airr:
+                adc-query-support: true
+        repertoire_description:
+            type: string
+            nullable: true
+            description: Description of this repertoire within the group
+            x-airr:
+                adc-query-support: true
+        time_point:
+            $ref: '#/TimePoint'
+            nullable: true
+            description: Time point designation for this repertoire within the group
+            x-airr:
+                adc-query-support: true
+
 RepertoireGroup:
     type: object
     required:
@@ -3271,26 +3293,7 @@ RepertoireGroup:
             description: >
                 List of repertoires in this collection with an associated description and time point designation
             items:
-                type: object
-                properties:
-                    repertoire_id:
-                        type: string
-                        nullable: false
-                        description: Identifier to the repertoire
-                        x-airr:
-                            adc-query-support: true
-                    repertoire_description:
-                        type: string
-                        nullable: true
-                        description: Description of this repertoire within the group
-                        x-airr:
-                            adc-query-support: true
-                    time_point:
-                        $ref: '#/TimePoint'
-                        nullable: true
-                        description: Time point designation for this repertoire within the group
-                        x-airr:
-                            adc-query-support: true
+                $ref: '#/RepertoireGroupDetail'
 
 Alignment:
     type: object

diff --git a/specs/airr-schema.yaml b/specs/airr-schema.yaml
@@ -3143,6 +3143,28 @@ Repertoire:
                 adc-query-support: true
 
 # A collection of repertoires for analysis purposes, includes optional time course
+RepertoireGroupDetail:
+    type: object
+    properties:
+        repertoire_id:
+            type: string
+            description: Identifier to the repertoire
+            x-airr:
+                nullable: false
+                adc-query-support: true
+        repertoire_description:
+            type: string
+            description: Description of this repertoire within the group
+            x-airr:
+                nullable: true
+                adc-query-support: true
+        time_point:
+            $ref: '#/TimePoint'
+            description: Time point designation for this repertoire within the group
+            x-airr:
+                nullable: true
+                adc-query-support: true
+
 RepertoireGroup:
     type: object
     required:
@@ -3165,26 +3187,7 @@ RepertoireGroup:
             description: >
                 List of repertoires in this collection with an associated description and time point designation
             items:
-                type: object
-                properties:
-                    repertoire_id:
-                        type: string
-                        description: Identifier to the repertoire
-                        x-airr:
-                            nullable: false
-                            adc-query-support: true
-                    repertoire_description:
-                        type: string
-                        description: Description of this repertoire within the group
-                        x-airr:
-                            nullable: true
-                            adc-query-support: true
-                    time_point:
-                        $ref: '#/TimePoint'
-                        description: Time point designation for this repertoire within the group
-                        x-airr:
-                            nullable: true
-                            adc-query-support: true
+                $ref: '#/RepertoireGroupDetail'
 
 
 Alignment: