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

[ENG-6782] Update preprint API documents #65

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[ENG-6782] Update preprint API documents #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions swagger-spec/preprints/definition.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ properties:
type: string
readOnly: false
description: 'The text of the any explanation of preprint preregistration link infomation.'
version:
type: integer
readOnly: true
description: 'Preprint version'
relationships:
type: object
title: Relationships
Expand Down
263 changes: 263 additions & 0 deletions swagger-spec/preprints/versioned_preprints_list.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@
get:
summary: List preprint versions
description: >-

A paginated list of all preprint versions for requested preprint.
The returned preprints are sorted by their creation date, with the most recent
preprints appearing first.

#### Returns

Returns a JSON object containing `data` and `links` keys.


The `data` key contains an array of preprint versions.
Each resource in the array is a separate preprint object.


The `links` key contains a dictionary of links that can be used
for [pagination](#tag/Pagination).


This request should never return an error.

parameters:
- in: path
type: string
required: true
name: preprint_id
description: 'The unique identifier of the preprint.'
tags:
- Preprints
operationId: versioned_preprints_list
x-response-schema: 'Preprint'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: 'definition.yaml'
examples:
application/json:
data:
- relationships:
node:
links:
related:
href: 'https://api.osf.io/v2/nodes/5xuck/'
meta: {}
citation:
links:
related:
href: 'https://api.osf.io/v2/preprints/hqb2p/citation/'
meta: {}
affiliated_institutions:
links:
related:
href: 'https://api.osf.io/v2/preprints/khbvy/institutions/'
meta: {}
self:
href: 'https://api.osf.io/v2/preprints/refm5/institutions/'
meta: {}
identifiers:
links:
related:
href: 'https://api.osf.io/v2/preprints/hqb2p/identifiers/'
meta: {}
primary_file:
links:
related:
href: 'https://api.osf.io/v2/files/5894204f594d900200ed23f2/'
meta: {}
license:
links:
related:
href: 'https://api.osf.io/v2/licenses/563c1cf88c5e4a3877f9e96a/'
meta: {}
provider:
links:
related:
href: 'https://api.osf.io/v2/preprint_providers/socarxiv/'
meta: {}
links:
self: 'https://api.osf.io/v2/preprints/hqb2p/'
html: 'https://osf.io/preprints/socarxiv/hqb2p/'
preprint_doi: 'https://dx.doi.org/10.5072/FK2OSF.IO/HQB2P'
attributes:
date_created: '2016-08-29T14:53:51.185000'
date_modified: '2016-08-29T14:53:51.185000'
date_published: '2016-08-29T14:53:51.185000'
original_publication_date: '2016-08-29T14:53:51.185000'
custom_publication_citation: 'Custom citation'
doi: 10.1371/journal.pbio.1002456
title: "Test Title"
description: "Test Description"
is_published: true
is_preprint_orphan: true
license_record: null
tags: []
preprint_doi_created: "2024-07-24T13:19:10.777018Z"
date_withdrawn: null
current_user_permissions: []
public: true
reviews_state: 'accepted'
date_last_transitioned: '2024-07-24T13:19:10.768264Z'
version: "int"
has_coi: null
conflict_of_interest_statement: null
has_data_links: null
why_no_data: null
data_links: null
has_prereg_links: null
why_no_prereg: null
prereg_links: null
prereg_link_info: null
type: preprints
id: khbvy_v{int}
links:
first:
last: https://api.osf.io/v2/preprints/?page=172
prev:
next: https://api.osf.io/v2/preprints/?page=2
meta:
total: 1720
per_page: 10

post:
summary: Create a preprint version
description: >-
Creates a new preprint version from requested preprint.

#### Returns

Returns a JSON object with a `data` key containing the representation of the created
preprint, if the request is successful.


If the request is unsuccessful, an `errors` key containing
information about the failure will be returned. Refer to the [list of error codes]()
to understand why this request may have failed.
parameters:
- in: path
type: string
required: true
name: preprint_id
description: 'The unique identifier of the preprint.'
tags:
- Preprints
operationId: preprints_create
consumes:
- application/json
x-response-schema: 'Preprint'
responses:
'201':
description: 'Success'
examples:
application/json:
data:
relationships:
contributors:
links:
related:
href: https://api.osf.io/v2/preprints/bnzx5/contributors/
meta: {}
bibliographic_contributors:
links:
related:
href: https://api.osf.io/v2/preprints/khbvy/bibliographic_contributors
meta: {}
citation:
links:
related:
href: https://api.osf.io/v2/preprints/khbvy/citation/
meta: {}
identifiers:
links:
related:
href: https://api.osf.io/v2/preprints/khbvy/identifiers/
meta: {}
node:
links:
related:
href: https://api.osf.io/v2/nodes/bnzx5/
meta: {}
data:
id: "<node_id>"
type: "nodes"
license:
data: null
provider:
links:
related:
href: https://api.osf.io/v2/preprint_providers/osf/
meta: {}
files:
links:
related:
href: https://api.osf.io/v2/preprints/bnzx5/files/
meta: {}
primary_file:
links:
related:
href: https://api.osf.io/v2/files/57c44b1e594d90004a421ab1/
meta: {}
review_actions:
links:
related:
href: https://api.osf.io/v2/preprints/bnzx5/review_actions/
meta: {}
requests:
links:
related:
href: https://api.osf.io/v2/preprints/bnzx5/requests/
meta: {}
affiliated_institutions:
links:
related:
href: https://api.osf.io/v2/preprints/bnzx5/institutions/
meta: {}
subjects:
links:
related:
href: https://api.osf.io/v2/preprints/bnzx5/subjects/
meta: {}
self:
href: https://api.osf.io/v2/preprints/bnzx5/relationships/institutions/
meta: {}
links:
self: https://api.osf.io/v2/preprints/bnzx5/
html: https://osf.io/bnzx5/
doi: https://dx.doi.org/10.1371/journal.pbio.1002456
preprint_doi: https://dx.doi.org/10.5072/FK2OSF.IO/KHBVY
attributes:
date_created: '2016-08-29T14:53:51.185000'
date_modified: '2016-08-29T14:53:51.185000'
date_published: '2016-08-29T14:53:51.185000'
original_publication_date: '2016-08-29T14:53:51.185000'
custom_publication_citation: 'Custom citation'
doi: 10.1371/journal.pbio.1002456
title: "Test Title"
description: "Test Description"
is_published: true
is_preprint_orphan: true
license_record: null
tags: []
preprint_doi_created: "2024-07-24T13:19:10.777018Z"
date_withdrawn: null
current_user_permissions: []
public: true
reviews_state: 'accepted'
date_last_transitioned: '2024-07-24T13:19:10.768264Z'
version: "int"
has_coi: null
conflict_of_interest_statement: null
has_data_links: null
why_no_data: null
data_links: null
has_prereg_links: null
why_no_prereg: null
prereg_links: null
prereg_link_info: null
type: preprints
id: khbvy_v{int}
3 changes: 3 additions & 0 deletions swagger-spec/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1104,6 +1104,9 @@ paths:
/preprints/:
$ref: 'preprints/list.yaml'

/preprints/{preprint_id}/versions/:
$ref: 'preprints/versioned_preprints_list.yaml'

/preprints/{preprint_id}/:
$ref: 'preprints/detail.yaml'

Expand Down