Skip to content

Commit 57355fa

Browse files
ihorsokhanexoftihorsokhanexoft
committed
updated endpoints for registrations providers
1 parent a03d4c3 commit 57355fa

4 files changed

Lines changed: 29 additions & 54 deletions

File tree

‎swagger-spec/registration_providers/definition.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ properties:
4343
banner_path:
4444
type: string
4545
description: The path to the banner image displayed for the provider.
46-
example: /static/img/registration_providers/cos-logo.png
46+
example: /static/img/providers/registrations/cos-logo.png
4747

4848
logo_path:
4949
type: string
5050
description: The path to the logo image for the provider.
51-
example: /static/img/registration_providers/cos-logo.png
51+
example: /static/img/providers/registrations/cos-logo.png
5252

5353
header_text:
5454
type: string
@@ -121,7 +121,7 @@ properties:
121121
href:
122122
type: string
123123
format: uri
124-
example: https://api.osf.io/v2/registration_providers/osf/licenses/
124+
example: https://api.osf.io/v2/providers/registrations/osf/licenses/
125125
meta:
126126
type: object
127127

@@ -138,7 +138,7 @@ properties:
138138
href:
139139
type: string
140140
format: uri
141-
example: https://api.osf.io/v2/registration_providers/osf/taxonomies/
141+
example: https://api.osf.io/v2/providers/registrations/osf/taxonomies/
142142
meta:
143143
type: object
144144

@@ -155,7 +155,7 @@ properties:
155155
href:
156156
type: string
157157
format: uri
158-
example: https://api.osf.io/v2/registration_providers/osf/registrations/
158+
example: https://api.osf.io/v2/providers/registrations/osf/registrations/
159159
meta:
160160
type: object
161161

@@ -167,13 +167,13 @@ properties:
167167
type: string
168168
format: uri
169169
description: The canonical API endpoint for this provider.
170-
example: https://api.osf.io/v2/registration_providers/osf/
170+
example: https://api.osf.io/v2/providers/registrations/osf/
171171

172172
registrations:
173173
type: string
174174
format: uri
175175
description: Link to the registrations list for this provider.
176-
example: https://api.osf.io/v2/registration_providers/osf/registrations/
176+
example: https://api.osf.io/v2/providers/registrations/osf/registrations/
177177

178178
external_url:
179179
type: string

‎swagger-spec/registration_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/registration_providers/osf/licenses/
87+
href: https://api.osf.io/v2/providers/registrations/osf/licenses/
8888
meta: {}
8989
taxonomies:
9090
links:
9191
related:
92-
href: https://api.osf.io/v2/registration_providers/osf/taxonomies/
92+
href: https://api.osf.io/v2/providers/registrations/osf/taxonomies/
9393
meta: {}
9494
registrations:
9595
links:
9696
related:
97-
href: https://api.osf.io/v2/registration_providers/osf/registrations/
97+
href: https://api.osf.io/v2/providers/registrations/osf/registrations/
9898
meta: {}
9999
links:
100-
self: https://api.osf.io/v2/registration_providers/osf/
101-
registrations: https://api.osf.io/v2/registration_providers/osf/registrations/
100+
self: https://api.osf.io/v2/providers/registrations/osf/
101+
registrations: https://api.osf.io/v2/providers/registrations/osf/registrations/
102102
external_url: https://osf.io/registrations/
103103
attributes:
104104
social_instagram: ''
105105
advisory_board: ''
106106
email_support: ''
107-
banner_path: "/static/img/registration_providers/cos-logo.png"
108-
logo_path: "/static/img/registration_providers/cos-logo.png"
107+
banner_path: "/static/img/providers/registrations/cos-logo.png"
108+
logo_path: "/static/img/providers/registrations/cos-logo.png"
109109
subjects_acceptable: []
110110
description: A scholarly commons to connect the entire research cycle
111111
social_facebook: ''

‎swagger-spec/registration_providers/list.yaml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# /registration_providers/
1+
# /providers/registrations/
22
get:
33
summary: List all Registration 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/registration_providers/?filter[id]=osf.
29+
https://api.osf.io/v2/providers/registrations/?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/registration_providers/osf/licenses/
50+
href: https://api.osf.io/v2/providers/registrations/osf/licenses/
5151
meta: {}
5252
taxonomies:
5353
links:
5454
related:
55-
href: https://api.osf.io/v2/registration_providers/osf/taxonomies/
55+
href: https://api.osf.io/v2/providers/registrations/osf/taxonomies/
5656
meta: {}
5757
registrations:
5858
links:
5959
related:
60-
href: https://api.osf.io/v2/registration_providers/osf/registrations/
60+
href: https://api.osf.io/v2/providers/registrations/osf/registrations/
6161
meta: {}
6262
links:
63-
self: https://api.osf.io/v2/registration_providers/osf/
64-
registrations: https://api.osf.io/v2/registration_providers/osf/registrations/
63+
self: https://api.osf.io/v2/providers/registrations/osf/
64+
registrations: https://api.osf.io/v2/providers/registrations/osf/registrations/
6565
external_url: https://osf.io/registrations/
6666
attributes:
6767
social_instagram: ''
6868
advisory_board: ''
6969
email_support: ''
70-
banner_path: "/static/img/registration_providers/cos-logo.png"
71-
logo_path: "/static/img/registration_providers/cos-logo.png"
70+
banner_path: "/static/img/providers/registrations/cos-logo.png"
71+
logo_path: "/static/img/providers/registrations/cos-logo.png"
7272
subjects_acceptable: []
7373
description: A scholarly commons to connect the entire research cycle
7474
social_facebook: ''

‎swagger-spec/swagger.yaml‎

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1941,6 +1941,9 @@ paths:
19411941
/providers/collections/{provider_id}/submissions/:
19421942
$ref: 'collection_providers/submissions_list.yaml'
19431943

1944+
/provider/collections/{provider_id}/subjects/:
1945+
$ref: 'collection_providers/subjects.yaml'
1946+
19441947
/providers/collections/{provider_id}/subjects/highlighted/:
19451948
$ref: 'collection_providers/subjects_highlighted_list.yaml'
19461949

@@ -1967,37 +1970,9 @@ paths:
19671970
/collection_submission_actions/:
19681971
$ref: 'collection_submission_actions/list.yaml'
19691972

1970-
############################
1971-
# COLLECTIONS PROVIDER #
1972-
############################
1973-
1974-
/provider/collections/:
1975-
$ref: 'collection_providers/list.yaml'
1976-
1977-
/provider/collections/{provider_id}/:
1978-
$ref: 'collection_providers/detail.yaml'
1979-
1980-
/provider/collections/{provider_id}/licenses/:
1981-
$ref: 'collection_providers/licenses_list.yaml'
1982-
1983-
/provider/collections/{provider_id}/submissions/:
1984-
$ref: 'collection_providers/submissions_list.yaml'
1985-
1986-
/provider/collections/{provider_id}/subjects/:
1987-
$ref: 'collection_providers/subjects.yaml'
1988-
1989-
/provider/collections/{provider_id}/subjects/highlighted/:
1990-
$ref: 'collection_providers/subjects_highlighted_list.yaml'
1991-
1992-
/provider/collections/{provider_id}/moderators/:
1993-
$ref: 'collection_providers/moderators_list.yaml'
1994-
1995-
/provider/collections/{provider_id}/moderators/{moderator_id}/:
1996-
$ref: 'collection_providers/moderators_detail.yaml'
1997-
1998-
#######################################
1999-
# REQUESTS #
2000-
#######################################
1973+
#######################################
1974+
# REQUESTS #
1975+
#######################################
20011976

20021977
/requests/{request_id}/:
20031978
$ref: 'requests/detail.yaml'

0 commit comments

Comments
 (0)