Skip to content

Commit a03d4c3

Browse files
ihorsokhanexoftihorsokhanexoft
committed
updated docs for preprint providers
1 parent ee70c82 commit a03d4c3

17 files changed

Lines changed: 304 additions & 192 deletions

‎swagger-spec/nodes/preprints_list.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ get:
5858
provider:
5959
links:
6060
related:
61-
href: https://api.osf.io/v2/preprint_providers/osf/
61+
href: https://api.osf.io/v2/providers/preprints/osf/
6262
meta: {}
6363
links:
6464
self: https://api.osf.io/v2/preprints/khbvy/

‎swagger-spec/preprint_providers/detail.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -84,28 +84,28 @@ get:
8484
licenses_acceptable:
8585
links:
8686
related:
87-
href: https://api.osf.io/v2/preprint_providers/osf/licenses/
87+
href: https://api.osf.io/v2/providers/preprints/osf/licenses/
8888
meta: {}
8989
taxonomies:
9090
links:
9191
related:
92-
href: https://api.osf.io/v2/preprint_providers/osf/taxonomies/
92+
href: https://api.osf.io/v2/providers/preprints/osf/taxonomies/
9393
meta: {}
9494
preprints:
9595
links:
9696
related:
97-
href: https://api.osf.io/v2/preprint_providers/osf/preprints/
97+
href: https://api.osf.io/v2/providers/preprints/osf/preprints/
9898
meta: {}
9999
links:
100-
self: https://api.osf.io/v2/preprint_providers/osf/
101-
preprints: https://api.osf.io/v2/preprint_providers/osf/preprints/
100+
self: https://api.osf.io/v2/providers/preprints/osf/
101+
preprints: https://api.osf.io/v2/providers/preprints/osf/preprints/
102102
external_url: https://osf.io/preprints/
103103
attributes:
104104
social_instagram: ''
105105
advisory_board: ''
106106
email_support: ''
107-
banner_path: "/static/img/preprint_providers/cos-logo.png"
108-
logo_path: "/static/img/preprint_providers/cos-logo.png"
107+
banner_path: "/static/img/providers/preprints/cos-logo.png"
108+
logo_path: "/static/img/providers/preprints/cos-logo.png"
109109
subjects_acceptable: []
110110
description: A scholarly commons to connect the entire research cycle
111111
social_facebook: ''

‎swagger-spec/preprint_providers/list.yaml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# /preprint_providers/
1+
# /providers/preprints/
22
get:
33
summary: List all preprint providers
44
description: >-
@@ -26,7 +26,7 @@ get:
2626
2727
You can optionally request that the response only include preprint providers that
2828
match your filters by utilizing the `filter` query parameter, e.g.
29-
https://api.osf.io/v2/preprint_providers/?filter[id]=osf.
29+
https://api.osf.io/v2/providers/preprints/?filter[id]=osf.
3030
3131
3232
Preprint Providers may be filtered by their `id`, `name`, and `description`
@@ -47,28 +47,28 @@ get:
4747
licenses_acceptable:
4848
links:
4949
related:
50-
href: https://api.osf.io/v2/preprint_providers/osf/licenses/
50+
href: https://api.osf.io/v2/providers/preprints/osf/licenses/
5151
meta: {}
5252
taxonomies:
5353
links:
5454
related:
55-
href: https://api.osf.io/v2/preprint_providers/osf/taxonomies/
55+
href: https://api.osf.io/v2/providers/preprints/osf/taxonomies/
5656
meta: {}
5757
preprints:
5858
links:
5959
related:
60-
href: https://api.osf.io/v2/preprint_providers/osf/preprints/
60+
href: https://api.osf.io/v2/providers/preprints/osf/preprints/
6161
meta: {}
6262
links:
63-
self: https://api.osf.io/v2/preprint_providers/osf/
64-
preprints: https://api.osf.io/v2/preprint_providers/osf/preprints/
63+
self: https://api.osf.io/v2/providers/preprints/osf/
64+
preprints: https://api.osf.io/v2/providers/preprints/osf/preprints/
6565
external_url: https://osf.io/preprints/
6666
attributes:
6767
social_instagram: ''
6868
advisory_board: ''
6969
email_support: ''
70-
banner_path: "/static/img/preprint_providers/cos-logo.png"
71-
logo_path: "/static/img/preprint_providers/cos-logo.png"
70+
banner_path: "/static/img/providers/preprints/cos-logo.png"
71+
logo_path: "/static/img/providers/preprints/cos-logo.png"
7272
subjects_acceptable: []
7373
description: A scholarly commons to connect the entire research cycle
7474
social_facebook: ''

‎swagger-spec/preprint_providers/moderator_definition.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ properties:
8080
type: string
8181
format: uri
8282
description: A link to this moderator resource.
83-
example: https://api.test.osf.io/v2/preprint_providers/provider_1/moderators/moderator_1/
83+
example: https://api.test.osf.io/v2/providers/preprints/provider_1/moderators/moderator_1/
8484
example:
8585
id: moderator_1
8686
type: moderators
@@ -95,4 +95,4 @@ example:
9595
type: preprint_providers
9696
id: provider_1
9797
links:
98-
self: https://api.test.osf.io/v2/preprint_providers/provider_1/moderators/moderator_1/
98+
self: https://api.test.osf.io/v2/providers/preprints/provider_1/moderators/moderator_1/

‎swagger-spec/preprint_providers/moderators_detail.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# /preprint_providers/{provider_id}/moderators/{moderator_id}/
1+
# /providers/preprints/{provider_id}/moderators/{moderator_id}/
22

33
get:
44
summary: Retrieve a Preprint Provider Moderator
@@ -51,7 +51,7 @@ get:
5151
type: "preprint_providers"
5252
id: "{provider_id}"
5353
links:
54-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/{moderator_id}/"
54+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/{moderator_id}/"
5555
meta:
5656
version: "2.0"
5757
'401':

‎swagger-spec/preprint_providers/moderators_list.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# /preprint_providers/{provider_id}/moderators/
1+
# /providers/preprints/{provider_id}/moderators/
22

33
get:
44
summary: List Moderators for a Preprint Provider
@@ -49,7 +49,7 @@ get:
4949
type: "preprint_providers"
5050
id: "{provider_id}"
5151
links:
52-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_1/"
52+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_1/"
5353
- id: "moderator_2"
5454
type: "moderators"
5555
attributes:
@@ -63,7 +63,7 @@ get:
6363
type: "preprint_providers"
6464
id: "{provider_id}"
6565
links:
66-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_2/"
66+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_2/"
6767
meta:
6868
total: 2
6969
version: "2.0"
@@ -168,7 +168,7 @@ post:
168168
type: "preprint_providers"
169169
id: "{provider_id}"
170170
links:
171-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_3/"
171+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_3/"
172172
meta:
173173
version: "2.0"
174174
'400':

‎swagger-spec/preprint_providers/preprints_list.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ get:
2828
2929
You can optionally request that the response only include preprints that
3030
match your filters by utilizing the `filter` query parameter, e.g.
31-
https://api.osf.io/v2/preprint_providers/osf/preprints/?filter[is_published]=true.
31+
https://api.osf.io/v2/providers/preprints/osf/preprints/?filter[is_published]=true.
3232
3333
3434
Preprints may be filtered by their `id`, `is_published`, `date_created`,
@@ -77,7 +77,7 @@ get:
7777
provider:
7878
links:
7979
related:
80-
href: 'https://api.osf.io/v2/preprint_providers/socarxiv/'
80+
href: 'https://api.osf.io/v2/providers/preprints/socarxiv/'
8181
meta: {}
8282
links:
8383
self: 'https://api.osf.io/v2/preprints/hqb2p/'

‎swagger-spec/preprint_providers/provider_moderator_detail.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# /preprint_providers/{provider_id}/moderators/{moderator_id}/
1+
# /providers/preprints/{provider_id}/moderators/{moderator_id}/
22

33
get:
44
summary: Retrieve a Moderator for a Preprint Provider
@@ -51,7 +51,7 @@ get:
5151
type: "preprint_providers"
5252
id: "{provider_id}"
5353
links:
54-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_1/"
54+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_1/"
5555
meta:
5656
version: "2.0"
5757
'401':
@@ -162,7 +162,7 @@ patch:
162162
type: "preprint_providers"
163163
id: "{provider_id}"
164164
links:
165-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_1/"
165+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_1/"
166166
meta:
167167
version: "2.0"
168168
'400':

‎swagger-spec/preprint_providers/provider_moderator_list.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# /preprint_providers/{provider_id}/moderators/
1+
# /providers/preprints/{provider_id}/moderators/
22

33
get:
44
summary: List Moderators for a Preprint Provider
@@ -77,7 +77,7 @@ get:
7777
type: "preprint_providers"
7878
id: "{provider_id}"
7979
links:
80-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_1/"
80+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_1/"
8181
- id: "moderator_2"
8282
type: "moderators"
8383
attributes:
@@ -91,9 +91,9 @@ get:
9191
type: "preprint_providers"
9292
id: "{provider_id}"
9393
links:
94-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_2/"
94+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_2/"
9595
links:
96-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/"
96+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/"
9797
next: null
9898
prev: null
9999
meta:
@@ -224,7 +224,7 @@ post:
224224
type: "preprint_providers"
225225
id: "{provider_id}"
226226
links:
227-
self: "https://api.test.osf.io/v2/preprint_providers/{provider_id}/moderators/moderator_3/"
227+
self: "https://api.test.osf.io/v2/providers/preprints/{provider_id}/moderators/moderator_3/"
228228
meta:
229229
version: "2.0"
230230

‎swagger-spec/preprint_providers/provider_subjects_list.yaml‎

Lines changed: 0 additions & 104 deletions
This file was deleted.

0 commit comments

Comments
 (0)