From 2280eff1227b1c8d4710c98749b09ff9b6562342 Mon Sep 17 00:00:00 2001
From: Richard Hallett <richard@richardhallett.com>
Date: Tue, 19 Mar 2019 16:08:15 +0100
Subject: [PATCH] Added some readonly options + added event attribute for
 writeOnly

---
 openapi.yaml | 31 ++++++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

diff --git a/openapi.yaml b/openapi.yaml
index ca67fbd91..a013d80bf 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -828,8 +828,10 @@ components:
                   type: string
                 created:
                   type: string
+                  readOnly: true
                 updated:
                   type: string
+                  readOnly: true
       required:
         - id
         - attributes - name - symbol - contactName - contactEmail
@@ -852,11 +854,14 @@ components:
               properties:
                 created:
                   type: string
+                  readOnly: true
                 updated:
                   type: string
+                  readOnly: true
       required:
         - id
     Doi:
+      description: Represents a DOI and provides access to metadata attributes, further schema specific information can be found at https://schema.datacite.org
       type: object
       properties:
         data:
@@ -875,6 +880,11 @@ components:
                   type: string
                 suffix:
                   type: string
+                event:
+                  description: Can be set to trigger a DOI state change.
+                  type: string
+                  enum: [publish, register, hide]
+                  writeOnly: true
                 identifiers:
                   type: array
                   items:
@@ -1101,10 +1111,12 @@ components:
                 isActive:
                   type: boolean
                 state:
+                  readOnly: true
                   type: string
                 reason:
                   type: string
                 landingPage:
+                  description: Data describing the landing page, used by link checking.
                   type: object
                   properties:
                     checked:
@@ -1135,10 +1147,13 @@ components:
                       type: boolean
                 created:
                   type: string
+                  readOnly: true
                 registered:
                   type: string
+                  readOnly: true
                 updated:
                   type: string
+                  readOnly: true
       required:
         - id
         - attributes - doi - creators - titles - publisher - publicationYear
@@ -1226,8 +1241,10 @@ components:
               properties:
                 created:
                   type: string
+                  readOnly: true
                 updated:
                   type: string
+                  readOnly: true
       required:
         - id
     Provider:
@@ -1269,8 +1286,8 @@ components:
             report-id:
               type: string
               description: >-
-                The report ID or code or shortname. Typically this will be the same
-                code provided in the Report parameter of the request.
+                The report ID or code or shortname. Typically this will be the
+                same code provided in the Report parameter of the request.
               example: DSR
             release:
               type: string
@@ -1290,14 +1307,14 @@ components:
             report-filters:
               type: string
               description: >-
-                Zero or more report filters used for this report. Typically reflect
-                filters provided on the Request. Filters limit the data to be
-                reported on.
+                Zero or more report filters used for this report. Typically
+                reflect filters provided on the Request. Filters limit the data
+                to be reported on.
             report-attributes:
               type: string
               description: >-
-                Zero or more additional attributes applied to the report. Attributes
-                inform the level of detail in the report.
+                Zero or more additional attributes applied to the report.
+                Attributes inform the level of detail in the report.
             reporting-period:
               type: string
               description: Time the report was prepared.