Skip to content

Commit

Permalink
Added some readonly options + added event attribute for writeOnly
Browse files Browse the repository at this point in the history
  • Loading branch information
richardhallett committed Mar 19, 2019
1 parent 6601bb6 commit 2280eff
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -828,8 +828,10 @@ components:
type: string
created:
type: string
readOnly: true
updated:
type: string
readOnly: true
required:
- id
- attributes - name - symbol - contactName - contactEmail
Expand All @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -1226,8 +1241,10 @@ components:
properties:
created:
type: string
readOnly: true
updated:
type: string
readOnly: true
required:
- id
Provider:
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 2280eff

Please sign in to comment.