Skip to content

Commit 43f7f3c

Browse files
nensornensor
committed
modified documentation to add comments and markdown to descriptions
Signed-off-by: Neal Ensor <[email protected]>
1 parent 780eaf7 commit 43f7f3c

File tree

1 file changed

+102
-36
lines changed

1 file changed

+102
-36
lines changed

‎swagger.yaml‎

Lines changed: 102 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -54,43 +54,16 @@ components:
5454
$ref: '#/components/schemas/contributorTypes'
5555
required:
5656
- contributor_type
57-
contributorTypes:
58-
type: string
59-
enum:
60-
- ContactPerson
61-
- DataCollector
62-
- DataCurator
63-
- DataManager
64-
- Distributor
65-
- Editor
66-
- HostingInstitution
67-
- Producer
68-
- ProjectLeader
69-
- ProjectManager
70-
- ProjectMember
71-
- RegistrationAgency
72-
- RegistrationAuthority
73-
- RelatedPerson
74-
- Researcher
75-
- ResearchGroup
76-
- RightsHolder
77-
- Sponsor
78-
- Supervisor
79-
- WorkPackageLeader
80-
- Other
8157
date:
8258
type: string
8359
anyOf:
8460
- format: year
8561
- format: yearmonth
8662
- format: date
8763
- format: datetime
88-
- format: year-range
89-
- format: yearmonth-range
90-
- format: date-range
91-
- format: datetime-range
9264
productTypes:
9365
type: string
66+
description: The general type of the work, report, or document for this record.
9467
enum:
9568
- Audiovisual
9669
- Collection
@@ -108,6 +81,7 @@ components:
10881
- Other
10982
identifierTypes:
11083
type: string
84+
description: The type of identifier represented by this value.
11185
enum:
11286
- ARK
11387
- arXiv
@@ -128,21 +102,114 @@ components:
128102
- URL
129103
- URN
130104
- w3id
105+
106+
contributorTypes:
107+
type: string
108+
description: |
109+
Describes the type of contribution to the work.
110+
|code|description|
111+
|----|-----------|
112+
|ContactPerson|Person with knowledge of how to access, troubleshoot, or otherwise field issues related to the resource.|
113+
|DataCollector|Person/institution responsible for finding or gathering data under the guidelines of the author(s) or Principal Investigator.|
114+
|DataCurator|Person tasked with reviewing, enhancing, cleaning, or standardizing metadata and the associated data submitted.|
115+
|DataManager|Person (or organisation with a staff of data managers, such as a data centre) responsible for maintaining the finished resource.|
116+
|Distributor|Institution tasked with responsibility to generate/disseminate copies of the resource in either electronic or print form.|
117+
|Editor|A person who oversees the details related to the publication format of the resource.|
118+
|HostingInstitution|The organisation allowing the resource to be available on the internet.|
119+
|Producer|Typically a person or organisation responsible for the artistry and form of a media product.|
120+
|ProjectLeader|Person officially designated as head of project team instrumental in the work necessary to development of the resource.|
121+
|ProjectManager|Person officially designated as manager of a project. Project may consist of one or many project teams and sub-teams.|
122+
|ProjectMember|Person on the membership list of a designated project/project team.|
123+
|RegistrationAgency|Institution officially appointed by a Registration Authority to handle specific tasks within a defined area of responsibility.|
124+
|RegistrationAuthority|A standards-setting body from which Registration Agencies obtain official recognition and guidance.|
125+
|RelatedPerson|Person with no specifically defined role in the development of the resource, but who is someone the author wishes to recognize.|
126+
|Researcher|A person involved in analyzing data or the results of an experiment or formal study.|
127+
|ResearchGroup|Refers to a group of individuals with a lab, department, or division; the group has a particular, defined focus of activity.|
128+
|RightsHolder|Person or institution owning or managing property rights, including intellectual property rights over the resource.|
129+
|Sponsor|Person or organisation that issued a contract or under the auspices of which a work has been performed.|
130+
|Supervisor|Designated administrator over one or more groups working to produce a resource or over one or more steps of development process.|
131+
|WorkPackageLeader|A Work Package is a recognized data product, not all of which is included in publication.|
132+
|Other|Any person or institution making a significant contribution, but whose contribution does not "fit".|
133+
enum:
134+
- ContactPerson
135+
- DataCollector
136+
- DataCurator
137+
- DataManager
138+
- Distributor
139+
- Editor
140+
- HostingInstitution
141+
- Producer
142+
- ProjectLeader
143+
- ProjectManager
144+
- ProjectMember
145+
- RegistrationAgency
146+
- RegistrationAuthority
147+
- RelatedPerson
148+
- Researcher
149+
- ResearchGroup
150+
- RightsHolder
151+
- Sponsor
152+
- Supervisor
153+
- WorkPackageLeader
154+
- Other
155+
131156
relationTypes:
132157
type: string
158+
description: |
159+
Indicates the relationship between this identifier and the source record.
160+
|code|description|
161+
|----|-----------|
162+
|Cites|indicates that A includes B in a citation|
163+
|Compiles|indicates B is the result of a compile or creation event using A|
164+
|Continues|indicates A is a continuation of the work B|
165+
|Describes|indicates A describes B|
166+
|Documents|indicates A is documentation about/B|
167+
|HasMetadata|indicates resource A has additional metadata B|
168+
|HasPart|indicates A includes the part B|
169+
|HasVersion|indicates A has a version of B|
170+
|IsCitedBy|indicates that B includes A in a citation|
171+
|IsCompiledBy|indicates B is used to compile or create A|
172+
|IsContinuedBy|indicates A is continued by the work B|
173+
|IsDerivedFrom|indicates B is a source upon which A is based|
174+
|IsDescribedBy|Indicates A is described by B|
175+
|IsDocumentedBy|indicates B is documentation about/explaining A|
176+
|IsIdenticalTo|indicates that A is identical to B, for use when there is a need to register two separate instances of the same resource|
177+
|IsMetadataFor|indicates additional metadata A for a resource B|
178+
|IsNewVersionOf|indicates A is a new edition of B, where the new edition has been modified or updated|
179+
|IsObsoletedBy|Indicates A is replaced by B|
180+
|IsOriginalFormOf|indicates A is the original form of B|
181+
|IsPartOf|indicates A is a portion of B; may be used for elements of a series|
182+
|IsPreviousVersionOf|indicates A is a previous edition of B|
183+
|IsReferencedBy|indicates A is used as a source of information by B|
184+
|IsRequiredBy|inidcates A is required by B|
185+
|IsReviewedBy|indicates that A is reviewed by B|
186+
|IsSourceOf|indicates A is a source upon which B is based|
187+
|IsSupplementTo|indicates that A is a supplement to B|
188+
|IsSupplementedBy|indicates that B is a supplement to A|
189+
|IsVariantFormOf|indicates A is a variant or different form of B, e.g. calculated or calibrated form or different packaging|
190+
|IsVersionOf|indicates A is a version of B|
191+
|Obsoletes|Indicates A replaces B|
192+
|References|indicates B is used as a source of information for A|
193+
|Requires|indicates A requires B|
194+
|Reviews|indicates that A is a review of B|
195+
133196
enum:
197+
- IsDescribedBy
198+
- Describes
199+
- HasVersion
200+
- IsVersionOf
201+
- IsRequiredBy
202+
- Requires
203+
- Obsoletes
204+
- IsObsoletedBy
134205
- IsCitedBy
135206
- Cites
136207
- IsSupplementTo
137208
- IsSupplementedBy
138209
- IsContinuedBy
139210
- Continues
140-
- IsDescribedBy
141-
- Describes
142211
- HasMetadata
143212
- IsMetadataFor
144-
- HasVersion
145-
- IsVersionOf
146213
- IsNewVersionOf
147214
- IsPreviousVersionOf
148215
- IsPartOf
@@ -160,12 +227,11 @@ components:
160227
- Reviews
161228
- IsDerivedFrom
162229
- IsSourceOf
163-
- IsRequiredBy
164-
- Requires
165-
- IsObsoletedBy
166-
- Obsoletes
230+
167231
recordType:
168232
type: object
233+
description: Represents the metadata information about a particular work, document, dataset, or
234+
paper for a given DOI record.
169235
properties:
170236
id:
171237
description: >-

0 commit comments

Comments
 (0)