Updated examples with latest publications and release numbers

HDRUK · Oct 8, 2024 · 2fc9ff8 · 2fc9ff8
1 parent b6713a6
commit 2fc9ff8
Showing 1 changed file with 64 additions and 34 deletions.
diff --git a/rest_api/static/rest_api/openapi/openapi-schema.yml b/rest_api/static/rest_api/openapi/openapi-schema.yml
@@ -568,6 +568,34 @@ components:
           format: date
           example: "2015-04-08"
 
+    PGSCatalogPublication:
+      type: object
+      properties:
+        title:
+          type: string
+          description: "Title of the publication"
+          example: 'Enhancing the Polygenic Score Catalog with tools for score calculation and ancestry normalization'
+        doi:
+          type: string
+          description: "doi of the publication"
+          example: '10.1038/s41588-024-01937-x'
+        PMID:
+          type: number
+          description: "PubMed ID"
+          example: 39327485
+        authors:
+          type: string
+          description: "Publication first author(s)"
+          example: 'Lambert et al'
+        journal:
+          type: string
+          description: "Name of the journal"
+          example: 'Nature Genetics'
+        year:
+          type: number
+          description: "Year of publication"
+          example: 2024
+
     Publication_extended:
       description: "Based on the **Publication** object, with the addition of the '**authors**' and the '**associated_pgs_ids**'."
       allOf:
@@ -2359,43 +2387,43 @@ paths:
                         type: string
                         description: "Date of the latest PGS release (format YYYY-MM-DD)"
                         format: date
-                        example: "2021-02-23"
+                        example: "2024-10-08"
                       scores:
                         type: number
                         description: "Number of Scores in the Catalog"
-                        example: 738
+                        example: 5001
                       traits:
                         type: number
                         description: "Number of Traits in the Catalog"
-                        example: 202
+                        example: 654
                       publications:
                         type: number
                         description: "Number of Publications in the Catalog"
-                        example: 144
+                        example: 673
                   citation:
                     type: object
                     description: "Information about the latest PGS Catalog publication"
                     properties:
                       title:
                         type: string
                         description: "Title of the publication"
-                        example: 'The Polygenic Score Catalog: new functionality and tools to enable FAIR research'
+                        example: 'Enhancing the Polygenic Score Catalog with tools for score calculation and ancestry normalization'
                       doi:
                         type: string
                         description: "doi of the publication"
-                        example: '10.1101/2024.05.29.24307783'
+                        example: '10.1038/s41588-024-01937-x'
                       PMID:
                         type: number
                         description: "PubMed ID"
-                        example: null
+                        example: 39327485
                       authors:
                         type: string
                         description: "List of the publication authors"
                         example: 'Samuel A. Lambert, ... , Michael Inouye'
                       journal:
                         type: string
                         description: "Name of the journal"
-                        example: 'medRxiv (Preprint)'
+                        example: 'Nature Genetics'
                       year:
                         type: number
                         description: "Year of publication"
@@ -2404,32 +2432,34 @@ paths:
                     type: array
                     description: "List of all PGS Catalog publications"
                     items:
-                      type: object
-                      properties:
-                        title:
-                          type: string
-                          description: "Title of the publication"
-                          example: 'The Polygenic Score Catalog as an open database for reproducibility and systematic evaluation'
-                        doi:
-                          type: string
-                          description: "doi of the publication"
-                          example: '10.1038/s41588-021-00783-5'
-                        PMID:
-                          type: number
-                          description: "PubMed ID"
-                          example: 33692568
-                        authors:
-                          type: string
-                          description: "Publication first author(s)"
-                          example: 'Lambert et al'
-                        journal:
-                          type: string
-                          description: "Name of the journal"
-                          example: 'Nature Genetics'
-                        year:
-                          type: number
-                          description: "Year of publication"
-                          example: 2021
+                      $ref: '#/components/schemas/PGSCatalogPublication'
+                    example: [
+                      {
+                        "title": "Enhancing the Polygenic Score Catalog with tools for score calculation and ancestry normalization",
+                        "doi": "10.1038/s41588-024-01937-x",
+                        "PMID": 39327485,
+                        "authors": "Lambert et al",
+                        "journal": "Nature Genetics",
+                        "year": 2024
+                      },
+                      {
+                        "title": "The NHGRI-EBI GWAS Catalog: knowledgebase and deposition resource",
+                        "authors": "Sollis et al",
+                        "year": 2023,
+                        "doi": "10.1093/nar/gkac1010",
+                        "PMID": 36350656,
+                        "journal": "Nucleic Acids Research 51(D1):D977-D985"
+                      },
+                      {
+                        "title": "The Polygenic Score Catalog as an open database for reproducibility and systematic evaluation",
+                        "authors": "Lambert et al",
+                        "year": 2021,
+                        "doi": "10.1038/s41588-021-00783-5",
+                        "PMID": 33692568,
+                        "journal": "Nature Genetics volume 53, pages420–425"
+                      }
+
+                    ]
                   ensembl_version:
                     type: number
                     description: "Ensembl version used to generate the Harmonized Scoring files"