Improve UI documentation

common/schemas/cross_reference.graphql

@@ -1,39 +1,140 @@
+"""
+Represents an external reference.
+A reference to a database outside of Ensembl.
+"""
 type ExternalReference {
-  # A reference to a database outside of Ensembl
+  """
+  The accession ID of the external reference.
+  """
   accession_id: String!
+
+  """
+  The name of the external reference.
+  """
   name: String!
+
+  """
+  A description of the external reference.
+  """
   description: String
+
+  """
+  The method used to assign this external reference.
+  """
   assignment_method: XrefMethod!
+
+  """
+  The URL of the external reference.
+  """
   url: String
+
+  """
+  The source database of the external reference.
+  """
   source: ExternalDB!
 }
 
+"""
+Some metadata about databases outside of Ensembl.
+"""
 type ExternalDB {
-  # Some metadata about databases outside of Ensembl
+  """
+  The unique identifier for the external database.
+  """
   id: String!
+
+  """
+  The name of the external database.
+  """
   name: String!
+
+  """
+  A description of the external database.
+  """
   description: String
+
+  """
+  The URL of the external database.
+  """
   url: String
+
+  """
+  The release version of the external database.
+  """
   release: String
 }
 
+"""
+Differentiate by reference assignment method.
+"""
 type XrefMethod {
-  # Differentiate by ref assignment method
+  """
+  The type of information for the reference assignment method.
+  """
   type: InfoType!
+
+  """
+  A description of the reference assignment method.
+  """
   description: String
 }
 
+"""
+Enum of valid types in the external reference pipeline.
+"""
 enum InfoType {
-  # Enum of valid types in the external reference pipeline
+  """
+  Projection method.
+  """
   PROJECTION
+
+  """
+  Miscellaneous method.
+  """
   MISC
+
+  """
+  Direct method.
+  """
   DIRECT
+
+  """
+  Sequence match method.
+  """
   SEQUENCE_MATCH
+
+  """
+  Inferred pair method.
+  """
   INFERRED_PAIR
+
+  """
+  Probe method.
+  """
   PROBE
+
+  """
+  Unmapped method.
+  """
   UNMAPPED
+
+  """
+  Coordinate overlap method.
+  """
   COORDINATE_OVERLAP
+
+  """
+  Checksum method.
+  """
   CHECKSUM
+
+  """
+  No method assigned.
+  """
   NONE
+
+  """
+  Dependent method.
+  """
   DEPENDENT
 }

common/schemas/dataset.graphql

@@ -1,11 +1,49 @@
+"""
+Represents a dataset containing various types of data.
+"""
 type Dataset {
+  """
+  The unique identifier for the dataset.
+  """
   dataset_id: String!
+
+  """
+  The name of the dataset.
+  """
   name: String!
+
+  """
+  The Ensembl release version the dataset is associated with.
+  """
   release: Float!
+
+  """
+  The type of the dataset.
+  """
   type: String!
+
+  """
+  The source from which the dataset was obtained.
+  """
   source: String!
+
+  """
+  The type category of the dataset.
+  """
   dataset_type: String!
+
+  """
+  The version of the dataset.
+  """
   version: String
+
+  """
+  The date when the dataset was released.
+  """
   release_date: String!
+
+  """
+  The release type of the dataset.
+  """
   release_type: String!
-}
+}

common/schemas/gene.graphql

@@ -1,16 +1,79 @@
+"""
+Represents a gene with various transcriptions.
+"""
 type Gene {
-  # The commonly understood concept of gene, with its various transcriptions.
+  """
+  The commonly understood concept of gene, with its various transcriptions.
+  """
   type: String!
+
+  """
+  The stable identifier of the gene.
+  """
   stable_id: String!
+
+  """
+  The unversioned stable identifier of the gene.
+  """
   unversioned_stable_id: String!
+
+  """
+  The version number of the gene.
+  """
   version: Int
+
+  """
+  The symbol of the gene.
+  """
   symbol: String
+
+  """
+  The name of the gene.
+  """
   name: String
+
+  """
+  The Sequence Ontology (SO) term associated with the gene.
+  """
   so_term: String!
+
+  """
+  The list of transcripts associated with the gene.
+  """
   transcripts: [Transcript!]!
-  transcripts_page(page: Int!, per_page: Int!): TranscriptsPage!
+
+  """
+  Fetches a paginated list of transcripts associated with the gene.
+  """
+  transcripts_page(
+    """
+    The page number to fetch.
+    """
+    page: Int!,
+
+    """
+    The number of transcripts per page.
+    """
+    per_page: Int!
+  ): TranscriptsPage!
+
+  """
+  The slice of the gene.
+  """
   slice: Slice!
+
+  """
+  The external references associated with the gene.
+  """
   external_references: [ExternalReference!]!
+
+  """
+  The alternative symbols for the gene.
+  """
   alternative_symbols: [String!]!
+
+  """
+  The metadata associated with the gene.
+  """
   metadata: GeneMetadata!
 }