Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates to openapi.yaml #1034

Merged
merged 7 commits into from
Nov 2, 2023
Merged

Updates to openapi.yaml #1034

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d275008
change request body to application/json
KellyStathis Oct 25, 2023
25d43f8
add igsnCatalog to client-type options
KellyStathis Oct 25, 2023
c7db6df
add additional params for GET /dois
KellyStathis Oct 25, 2023
5e7ceab
add user-id
KellyStathis Nov 1, 2023
488dcd7
add descriptions for funder-id and affiliation-id
KellyStathis Nov 1, 2023
8ab70c6
add has-* and source parameters
KellyStathis Nov 1, 2023
14fd098
Field name changes to match public-facing attribute names
codycooperross Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 115 additions & 4 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ paths:
enum:
- repository
- periodical
- igsnCatalog
- in: query
name: repository-type
schema:
Expand Down Expand Up @@ -341,6 +342,14 @@ paths:
name: prefix
schema:
type: string
- in: query
name: client-type
schema:
type: string
enum:
- repository
- periodical
- igsnCatalog
- in: query
name: certificate
schema:
Expand All @@ -355,10 +364,22 @@ paths:
- WDS
- in: query
name: affiliation-id
description: Searches creators.affiliation.affiliationIdentifier and contributors.affiliation.affiliationIdentifier for a ROR ID.
schema:
type: string
- in: query
name: funder-id
description: Searches fundingReferences.funderIdentifier for a Crossref Funder ID.
schema:
type: string
- in: query
name: user-id
description: Searches creators.nameIdentifiers.nameIdentifier for an ORCID iD.
schema:
type: string
- in: query
name: resource-type-id
description: Filter by the resourceTypeGeneral.
schema:
type: string
enum:
Expand Down Expand Up @@ -390,6 +411,11 @@ paths:
- text
- workflow
- other
- in: query
name: resource-type
description: Filter by the free text resourceType.
schema:
type: string
- in: query
name: subject
schema:
Expand Down Expand Up @@ -435,6 +461,66 @@ paths:
- 500
- 502
- 503
- in: query
name: has-citations
description: Searches the citationCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-references
description: Searches the referenceCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-parts
description: Searches the partCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-part-of
description: Searches the partOfCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-versions
description: Searches the versionCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-version-of
description: Searches the versionOfCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-views
description: Searches the viewCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-downloads
description: Searches the downloadCount field for integer values greater than or equal to the inputted value.
schema:
type: integer
- in: query
name: has-person
description: Returns DOIs where creators.nameIdentifiers.nameIdentifierScheme has at least one "ORCID" value.
schema:
type: boolean
- in: query
name: has-affiliation
description: Returns DOIs where either creators.affiliation.affiliationIdentifierScheme or contributors.affiliation.affiliationIdentifierScheme has at least one "ROR" value.
schema:
type: boolean
- in: query
name: has-organization
description: Returns DOIs where either creators.nameIdentifiers.nameIdentifierScheme or contributors.nameIdentifiers.nameIdentifierScheme has at least one "ROR" value.
schema:
type: boolean
- in: query
name: has-funder
description: Returns DOIs where fundingReferences.funderIdentifierType has at least one "Crossref Funder ID" value.
schema:
type: boolean
- in: query
name: random
description: Retreive a random sample of DOIs. When true, the page[number] parameter is ignored.
Expand Down Expand Up @@ -487,6 +573,31 @@ paths:
- '-created'
- updated
- '-updated'
- in: query
name: disable-facets
description: Exclude facets from the response.
schema:
type: boolean
- in: query
name: detail
description: When set to true, will include the following attributes in the response - prefix, suffix, viewsOverTime, citationsOverTime, provider, references, citations. parts, partOf, versions, versionOf, xml, alternateIdentifiers.
schema:
type: boolean
- in: query
name: field[dois]
description: Only return the attributes specified. For example, "fields[dois]=titles,subjects" will only return titles and subjects.
schema:
type: string
- in: query
name: source
schema:
type: string
enum:
- mds
- api
- fabricaForm
- fabrica
- ez
responses:
'200':
description: A JSON array of dois.
Expand All @@ -504,7 +615,7 @@ paths:
requestBody:
required: true
content:
application/vnd.api+json:
application/json:
schema:
$ref: '#/components/schemas/Doi'
responses:
Expand Down Expand Up @@ -546,7 +657,7 @@ paths:
requestBody:
required: true
content:
application/vnd.api+json:
application/json:
schema:
$ref: '#/components/schemas/Doi'
responses:
Expand Down Expand Up @@ -1047,7 +1158,7 @@ paths:
requestBody:
required: true
content:
application/vnd.api+json:
application/json:
schema:
$ref: '#/components/schemas/Report'
responses:
Expand Down Expand Up @@ -1089,7 +1200,7 @@ paths:
requestBody:
required: true
content:
application/vnd.api+json:
application/json:
schema:
$ref: '#/components/schemas/Report'
responses:
Expand Down