@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api OSF APIv2 Documentation
@base https://api.test.osf.io/v2
@version 2.0
@endpoints 343
@hint download_for_search
@toc addons(1), root(1), citations(2), comments(2), files(5), licenses(1), license(1), logs(1), actions(5), institutions(11), schemas(2), schema_responses(10), nodes(65), preprints(24), preprint_providers(11), providers(37), registrations(39), draft_registrations(17), taxonomies(2), users(28), view_only_links(2), wikis(5), collections(21), collection_submissions(1), collection_submission_actions(2), provider(8), requests(2), resources(5), subjects(3), guids(1), custom_file_metadata_records(2), custom_item_metadata_records(2), subscriptions(3), registration_subscriptions(2), collection_subscriptions(2), regions(2), tokens(5), applications(6), scopes(2), identifiers(2)

@group addons
@endpoint GET /addons/
@returns(200)

@endgroup

@group root
@endpoint GET /
@returns(200)

@endgroup

@group citations
@endpoint GET /citations/styles/
@returns(200)

@endpoint GET /citations/styles/{style_id}/
@required {style_id: any}
@returns(200)

@endgroup

@group comments
@endpoint GET /comments/{comment_id}/
@required {comment_id: any}
@returns(200)

@endpoint DELETE /comments/{comment_id}/
@required {comment_id: any}
@returns(204)

@endgroup

@group files
@endpoint GET /files/{file_id}/
@required {file_id: any}
@returns(200)

@endpoint PATCH /files/{file_id}/
@required {file_id: any, body: map}
@returns(200)

@endpoint GET /files/{file_id}/versions/
@required {file_id: any}
@returns(200)

@endpoint GET /files/{file_id}/versions/{version_id}/
@required {file_id: any, version_id: any}
@returns(200)

@endgroup

@group licenses
@endpoint GET /licenses/
@returns(200)

@endgroup

@group license
@endpoint GET /license/{license_id}/
@required {license_id: any}
@returns(200)

@endgroup

@group logs
@endpoint GET /logs/{log_id}/
@required {log_id: any}
@returns(200)

@endgroup

@group actions
@endpoint GET /actions/
@returns(200)

@endgroup

@group institutions
@endpoint GET /institutions/
@returns(200)

@endpoint GET /institutions/{institution_id}/
@required {institution_id: any}
@returns(200)

@endpoint GET /institutions/{institution_id}/users/
@required {institution_id: any}
@returns(200)

@endpoint GET /institutions/{institution_id}/nodes/
@required {institution_id: any}
@returns(200)

@endpoint GET /institutions/{institution_id}/registrations/
@required {institution_id: any}
@returns(200)

@endpoint GET /institutions/{institution_id}/relationships/nodes/
@required {institution_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint POST /institutions/{institution_id}/relationships/nodes/
@required {institution_id: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 404}

@endpoint DELETE /institutions/{institution_id}/relationships/nodes/
@required {institution_id: any, body: map}
@returns(204)
@errors {400, 401, 403, 404}

@endpoint GET /institutions/{institution_id}/relationships/registrations/
@required {institution_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint POST /institutions/{institution_id}/relationships/registrations/
@required {institution_id: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 404}

@endpoint DELETE /institutions/{institution_id}/relationships/registrations/
@required {institution_id: any, body: map}
@returns(204)
@errors {400, 401, 403, 404}

@endgroup

@group schemas
@endpoint GET /schemas/registrations/
@returns(200)

@endpoint GET /schemas/registrations/{registration_schema_id}
@required {registration_schema_id: any}
@returns(200)

@endgroup

@group schema_responses
@endpoint GET /schema_responses/
@returns(200)

@endpoint POST /schema_responses/
@required {body: map}
@returns(201)

@endpoint GET /schema_responses/{schema_response_id}
@required {schema_response_id: any}
@returns(200)

@endpoint PATCH /schema_responses/{schema_response_id}
@required {schema_response_id: any, body: map}
@returns(201)

@endpoint DELETE /schema_responses/{schema_response_id}
@required {schema_response_id: any}
@returns(204)

@endpoint GET /schema_responses/{schema_response_id}/actions/
@required {schema_response_id: any}
@returns(200)

@endpoint POST /schema_responses/{schema_response_id}/actions/
@required {schema_response_id: any}
@returns(201)

@endpoint GET /schema_responses/{schema_response_id}/actions/{schema_response_action_id}
@required {schema_response_id: any, schema_response_action_id: any}
@returns(200)

@endpoint GET /schema_responses/{schema_response_id}/schema_blocks/
@required {schema_response_id: any}
@returns(200)

@endpoint GET /schema_responses/{schema_response_id}/schema_blocks/{schema_response_block_id}
@required {schema_response_id: any, schema_response_block_id: any}
@returns(200)

@endgroup

@group nodes
@endpoint GET /nodes/
@returns(200)

@endpoint POST /nodes/
@required {body: map}
@returns(201)

@endpoint GET /nodes/{node_id}/
@required {node_id: any}
@returns(200)

@endpoint PATCH /nodes/{node_id}/
@required {node_id: any, body: map}
@returns(200)

@endpoint DELETE /nodes/{node_id}/
@required {node_id: any}
@returns(204)

@endpoint GET /nodes/{node_id}/addons/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/addons/{provider}/folders/
@required {node_id: any, provider: any}
@returns(200)

@endpoint GET /nodes/{node_id}/addons/{provider}/
@required {node_id: any, provider: any}
@returns(200)

@endpoint PATCH /nodes/{node_id}/addons/{provider}/
@required {node_id: any, provider: any, body: map}
@returns(200)

@endpoint GET /nodes/{node_id}/children/
@required {node_id: any}
@returns(200)

@endpoint POST /nodes/{node_id}/children/
@required {node_id: any, body: map}
@returns(201)

@endpoint GET /nodes/{node_id}/citation/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/citation/{style_id}/
@required {style_id: any, node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/comments/
@required {node_id: any}
@returns(200)

@endpoint POST /nodes/{node_id}/comments/
@required {node_id: any, body: map}
@returns(201)

@endpoint GET /nodes/{node_id}/contributors/
@required {node_id: any}
@returns(200)

@endpoint POST /nodes/{node_id}/contributors/
@required {node_id: any, body: map}
@returns(201)

@endpoint GET /nodes/{node_id}/contributors/{user_id}/
@required {node_id: any, user_id: any}
@returns(200)

@endpoint PATCH /nodes/{node_id}/contributors/{user_id}/
@required {node_id: any, user_id: any, body: map}
@returns(200)

@endpoint DELETE /nodes/{node_id}/contributors/{user_id}/
@required {node_id: any, user_id: any}
@returns(204)

@endpoint GET /nodes/{node_id}/draft_registrations/
@required {node_id: any}
@returns(200)

@endpoint POST /nodes/{node_id}/draft_registrations/
@required {node_id: any, body: map}
@returns(201)

@endpoint GET /nodes/{node_id}/draft_registrations/{draft_id}/
@required {node_id: any, draft_id: any}
@returns(200)

@endpoint PATCH /nodes/{node_id}/draft_registrations/{draft_id}/
@required {node_id: any, draft_id: any, body: map}
@returns(200)

@endpoint DELETE /nodes/{node_id}/draft_registrations/{draft_id}/
@required {node_id: any, draft_id: any}
@returns(204)

@endpoint GET /nodes/{node_id}/files/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/files/providers/{provider}/
@required {node_id: any, provider: any}
@returns(200)

@endpoint GET /nodes/{node_id}/files/{provider}/
@required {node_id: any, provider: any}
@returns(200)

@endpoint GET /nodes/{node_id}/files/{provider}/{path}/
@required {node_id: any, provider: any, path: any}
@returns(200)

@endpoint GET /nodes/{node_id}/identifiers/
@required {node_id: any}
@returns(200)

@endpoint POST /nodes/{node_id}/identifiers/
@required {node_id: any}
@returns(201)
@errors {400, 403, 404}

@endpoint GET /nodes/{node_id}/institutions/
@required {node_id: any}
@returns(200)

@endpoint POST /nodes/{node_id}/forks/
@required {node_id: any, body: map}
@returns(201)

@endpoint GET /nodes/{node_id}/forks/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/linked_nodes/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/logs/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/preprints/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/registrations/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/view_only_links/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/view_only_links/{link_id}/
@required {node_id: any, link_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/wikis/
@required {node_id: any}
@returns(200)

@endpoint GET /nodes/{node_id}/linked_by_nodes/
@required {node_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /nodes/{node_id}/linked_by_registrations/
@required {node_id: any}
@optional {page: any, filter: any, sort: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /nodes/{node_id}/relationships/institutions/
@required {node_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /nodes/{node_id}/relationships/institutions/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint POST /nodes/{node_id}/relationships/institutions/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint DELETE /nodes/{node_id}/relationships/institutions/
@required {node_id: any, body: map}
@returns(204)
@errors {400, 401, 403, 404}

@endpoint GET /nodes/{node_id}/relationships/linked_nodes/
@required {node_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /nodes/{node_id}/relationships/linked_nodes/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint POST /nodes/{node_id}/relationships/linked_nodes/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint DELETE /nodes/{node_id}/relationships/linked_nodes/
@required {node_id: any, body: map}
@returns(204)
@errors {400, 401, 403, 404}

@endpoint GET /nodes/{node_id}/relationships/linked_registrations/
@required {node_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /nodes/{node_id}/relationships/linked_registrations/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint POST /nodes/{node_id}/relationships/linked_registrations/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint DELETE /nodes/{node_id}/relationships/linked_registrations/
@required {node_id: any, body: map}
@returns(204)
@errors {400, 401, 403, 404}

@endpoint GET /nodes/{node_id}/relationships/subjects/
@required {node_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /nodes/{node_id}/relationships/subjects/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint POST /nodes/{node_id}/relationships/subjects/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint DELETE /nodes/{node_id}/relationships/subjects/
@required {node_id: any, body: map}
@returns(204)
@errors {400, 401, 403, 404}

@endpoint GET /nodes/{node_id}/requests/
@required {node_id: any}
@optional {filter[type]: any, filter[state]: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /nodes/{node_id}/settings/
@required {node_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /nodes/{node_id}/settings/
@required {node_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint GET /nodes/{node_id}/storage/
@required {node_id: any}
@optional {page: any, embed: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /nodes/{node_id}/subjects/
@required {node_id: any}
@optional {page: any, filter: any, embed: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group preprints
@endpoint GET /preprints/
@returns(200)

@endpoint POST /preprints/
@required {data: map}
@returns(201)

@endpoint GET /preprints/{preprint_id}/versions/
@required {preprint_id: any}
@returns(200)

@endpoint POST /preprints/{preprint_id}/versions/
@required {preprint_id: any}
@returns(201)

@endpoint GET /preprints/{preprint_id}/
@required {preprint_id: any}
@returns(200)

@endpoint PATCH /preprints/{preprint_id}/
@required {preprint_id: any, data: map}
@returns(200)

@endpoint GET /preprints/{preprint_id}/citation/
@required {preprint_id: any}
@returns(200)

@endpoint GET /preprints/{preprint_id}/citation/{style_id}/
@required {style_id: any, preprint_id: any}
@returns(200)

@endpoint GET /preprints/{preprint_id}/contributors/
@required {preprint_id: any}
@returns(200)

@endpoint POST /preprints/{preprint_id}/contributors/
@required {preprint_id: any, body: map}
@returns(201)

@endpoint GET /preprints/{preprint_id}/contributors/{user_id}/
@required {preprint_id: any, user_id: any}
@returns(200)

@endpoint GET /preprints/{preprint_id}/bibliographic_contributors/
@required {preprint_id: any}
@returns(200)

@endpoint GET /preprints/{preprint_id}/institutions/
@required {preprint_id: any}
@returns(200)

@endpoint GET /preprints/{preprint_id}/relationships/institutions/
@required {preprint_id: any}
@returns(200)

@endpoint PUT /preprints/{preprint_id}/relationships/institutions/
@required {preprint_id: any, body: map}
@returns(201)

@endpoint GET /preprints/{preprint_id}/files/
@required {preprint_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /preprints/{preprint_id}/files/osfstorage/
@required {preprint_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /preprints/{preprint_id}/identifiers/
@required {preprint_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /preprints/{preprint_id}/relationships/node/
@required {preprint_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /preprints/{preprint_id}/relationships/node/
@required {preprint_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint DELETE /preprints/{preprint_id}/relationships/node/
@required {preprint_id: any}
@returns(204)
@errors {401, 403, 404}

@endpoint POST /preprints/{preprint_id}/requests/
@required {preprint_id: any, body: map}
@returns(201)
@errors {400, 401, 403, 404}

@endpoint GET /preprints/{preprint_id}/review_actions/
@required {preprint_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /preprints/{preprint_id}/subjects/
@required {preprint_id: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group preprint_providers
@endpoint GET /preprint_providers/
@returns(200)

@endpoint GET /preprint_providers/{provider_id}/
@required {provider_id: any}
@returns(200)

@endpoint GET /preprint_providers/{provider_id}/preprints/
@required {provider_id: any}
@returns(200)

@endpoint GET /preprint_providers/{provider_id}/taxonomies/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /preprint_providers/{provider_id}/taxonomies/highlighted/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group providers
@endpoint GET /providers/preprints/{provider_id}/citation_styles/
@required {provider_id: any}
@optional {filter[default]: any, page: any, per_page: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group preprint_providers
@endpoint GET /preprint_providers/{provider_id}/licenses/
@required {provider_id: any}
@returns(200)

@endpoint GET /preprint_providers/{provider_id}/moderators/
@required {provider_id: any}
@optional {page: any, filter[permission_group]: any}
@returns(200)
@errors {401, 403, 404}

@endpoint POST /preprint_providers/{provider_id}/moderators/
@required {provider_id: any, body: map}
@returns(201)
@errors {400, 401, 403, 404}

@endpoint GET /preprint_providers/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /preprint_providers/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint DELETE /preprint_providers/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any}
@returns(204)
@errors {401, 403, 404}

@endgroup

@group providers
@endpoint GET /providers/preprints/{provider_id}/withdraw_requests/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group registrations
@endpoint GET /registrations/
@returns(200)

@endpoint GET /registrations/{registration_id}/
@required {registration_id: any}
@returns(200)

@endpoint PATCH /registrations/{registration_id}/
@required {registration_id: any, body: map}
@returns(200)

@endpoint GET /registrations/{registration_id}/citations/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/citations/{citation_id}/
@required {registration_id: any, citation_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/children/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/comments/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/contributors/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/contributors/{user_id}/
@required {registration_id: any, user_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/files/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/files/{provider}/
@required {registration_id: any, provider: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/files/{provider}/{path}/
@required {registration_id: any, provider: any, path: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/forks/
@required {registration_id: any}
@returns(200)

@endpoint POST /registrations/{registration_id}/forks/
@required {registration_id: any, body: map}
@returns(201)

@endpoint GET /registrations/{registration_id}/identifiers/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/institutions/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/linked_nodes/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/logs/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/actions/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/bibliographic_contributors/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/cedar_metadata_records/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/citation/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/citation/{citation_id}/
@required {registration_id: any, citation_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/implicit_contributors/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/linked_by_nodes/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/linked_by_registrations/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/node_links/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/registrations/
@required {registration_id: any}
@optional {page: any, filter: any, embed: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/relationships/institutions/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/relationships/linked_nodes/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/relationships/linked_registrations/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/relationships/subjects/
@required {registration_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/requests/
@required {registration_id: any}
@optional {filter[type]: any, page: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/resources/
@required {registration_id: any}
@optional {page: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/schema_responses/
@required {registration_id: any}
@optional {page: any, filter[state]: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/subjects/
@required {registration_id: any}
@optional {page: any, filter[text]: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /registrations/{registration_id}/view_only_links/
@required {registration_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/view_only_links/{link_id}/
@required {registration_id: any, link_id: any}
@returns(200)

@endpoint GET /registrations/{registration_id}/wikis/
@required {registration_id: any}
@returns(200)

@endgroup

@group providers
@endpoint GET /providers/registrations/
@returns(200)

@endpoint GET /providers/registrations/{provider_id}/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/registrations/{provider_id}/registrations/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/registrations/{provider_id}/taxonomies/
@required {provider_id: any}
@optional {filter[parent]: any}
@returns(200)

@endpoint GET /providers/registrations/{provider_id}/taxonomies/highlighted/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/registrations/{provider_id}/licenses/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/registrations/{provider_id}/actions/
@required {provider_id: any}
@optional {page: any, per_page: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/registrations/{provider_id}/requests/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/registrations/{provider_id}/schemas/
@required {provider_id: any}
@optional {filter[active]: any, page: any, per_page: any}
@returns(200)
@errors {400, 404}

@endpoint GET /providers/registrations/{provider_id}/subjects/
@required {provider_id: any}
@optional {page: any, per_page: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/registrations/{provider_id}/submissions/
@required {provider_id: any}
@optional {filter[state]: any, page: any, per_page: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/registrations/{provider_id}/subjects/highlighted/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/registrations/{provider_id}/moderators/
@required {provider_id: any}
@returns(200)

@endpoint POST /providers/registrations/{provider_id}/moderators/
@required {provider_id: any, body: map}
@returns(201)
@errors {400, 403}

@endpoint GET /providers/registrations/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any}
@returns(200)
@errors {403, 404}

@endpoint PATCH /providers/registrations/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any, body: map}
@returns(200)
@errors {400, 403}

@endpoint DELETE /providers/registrations/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any}
@returns(204)
@errors {403, 404}

@endgroup

@group draft_registrations
@endpoint GET /draft_registrations/
@returns(200)

@endpoint POST /draft_registrations/
@required {body: map}
@returns(201)

@endpoint GET /draft_registrations/{draft_id}/
@required {draft_id: any}
@returns(200)

@endpoint PATCH /draft_registrations/{draft_id}/
@required {draft_id: any, body: map}
@returns(200)

@endpoint DELETE /draft_registrations/{draft_id}/
@required {draft_id: any}
@returns(204)

@endpoint GET /draft_registrations/{draft_id}/contributors/
@required {draft_id: any}
@returns(200)

@endpoint POST /draft_registrations/{draft_id}/contributors/
@required {draft_id: any, body: map}
@returns(201)

@endpoint GET /draft_registrations/{draft_id}/contributors/{user_id}/
@required {draft_id: any, user_id: any}
@returns(200)

@endpoint GET /draft_registrations/{draft_id}/institutions/
@required {draft_id: any}
@returns(200)

@endpoint GET /draft_registrations/{draft_id}/subjects/
@required {draft_id: any}
@returns(200)

@endpoint GET /draft_registrations/{draft_id}/bibliographic_contributors/
@required {draft_id: any}
@returns(200)
@errors {403, 404}

@endpoint GET /draft_registrations/{draft_id}/relationships/institutions/
@required {draft_id: any}
@returns(200)
@errors {403, 404}

@endpoint POST /draft_registrations/{draft_id}/relationships/institutions/
@required {draft_id: any, body: map}
@returns(204)
@errors {400, 403, 404}

@endpoint DELETE /draft_registrations/{draft_id}/relationships/institutions/
@required {draft_id: any, body: map}
@returns(204)
@errors {403, 404}

@endpoint GET /draft_registrations/{draft_id}/relationships/subjects/
@required {draft_id: any}
@returns(200)
@errors {403, 404}

@endpoint POST /draft_registrations/{draft_id}/relationships/subjects/
@required {draft_id: any, body: map}
@returns(204)
@errors {403, 404}

@endpoint DELETE /draft_registrations/{draft_id}/relationships/subjects/
@required {draft_id: any, body: map}
@returns(204)
@errors {403, 404}

@endgroup

@group taxonomies
@endpoint GET /taxonomies/
@returns(200)

@endpoint GET /taxonomies/{taxonomy_id}/
@required {taxonomy_id: any}
@returns(200)

@endgroup

@group users
@endpoint GET /users/
@returns(200)

@endpoint GET /users/{user_id}/
@required {user_id: any}
@returns(200)

@endpoint PATCH /users/{user_id}/
@required {user_id: any, body: map}
@returns(200)

@endpoint GET /users/{user_id}/institutions/
@required {user_id: any}
@returns(200)

@endpoint GET /users/{user_id}/nodes/
@required {user_id: any}
@returns(200)

@endpoint GET /users/{user_id}/preprints/
@required {user_id: any}
@returns(200)

@endpoint GET /users/{user_id}/registrations/
@required {user_id: any}
@returns(200)

@endpoint GET /users/{user_id}/addons/
@required {user_id: any}
@returns(200)

@endpoint GET /users/{user_id}/addons/{provider}/
@required {user_id: any, provider: any}
@returns(200)

@endpoint GET /users/{user_id}/addons/{provider}/accounts/
@required {user_id: any, provider: any}
@returns(200)

@endpoint GET /users/{user_id}/addons/{provider}/accounts/{account_id}/
@required {user_id: any, provider: any, account_id: any}
@returns(200)

@endpoint POST /users/{user_id}/claim/
@required {user_id: any, body: map}
@returns(204)
@errors {400, 403, 404}

@endpoint GET /users/{user_id}/draft_preprints/
@required {user_id: any}
@optional {page: any, filter[title]: any}
@returns(200)
@errors {403, 404}

@endpoint GET /users/{user_id}/draft_registrations/
@required {user_id: any}
@optional {page: any, filter[title]: any}
@returns(200)
@errors {403, 404}

@endpoint GET /users/{user_id}/relationships/institutions/
@required {user_id: any}
@returns(200)
@errors {403, 404}

@endpoint DELETE /users/{user_id}/relationships/institutions/
@required {user_id: any, body: map}
@returns(204)
@errors {400, 403, 404}

@endpoint GET /users/{user_id}/settings/
@required {user_id: any}
@returns(200)
@errors {403}

@endpoint PATCH /users/{user_id}/settings/
@required {user_id: any, body: map}
@returns(200)
@errors {400, 403, 404}

@endpoint GET /users/{user_id}/settings/emails/
@required {user_id: any}
@returns(200)
@errors {403}

@endpoint POST /users/{user_id}/settings/emails/
@required {user_id: any, body: map}
@returns(201)
@errors {400, 403, 429}

@endpoint GET /users/{user_id}/settings/emails/{email_id}/
@required {user_id: any, email_id: any}
@optional {resend_confirmation: any}
@returns(200)
@errors {403, 404}

@endpoint PATCH /users/{user_id}/settings/emails/{email_id}/
@required {user_id: any, email_id: any, body: map}
@returns(200)
@errors {400, 403, 404}

@endpoint DELETE /users/{user_id}/settings/emails/{email_id}/
@required {user_id: any, email_id: any}
@returns(204)
@errors {400, 403, 404}

@endpoint POST /users/{user_id}/settings/export/
@required {user_id: any, body: map}
@returns(204)
@errors {403, 429}

@endpoint GET /users/{user_id}/settings/identities/
@required {user_id: any}
@returns(200)
@errors {403}

@endpoint GET /users/{user_id}/settings/identities/{identity_id}
@required {user_id: any, identity_id: any}
@returns(200)
@errors {403, 404}

@endpoint DELETE /users/{user_id}/settings/identities/{identity_id}
@required {user_id: any, identity_id: any}
@returns(204)
@errors {403, 404}

@endpoint POST /users/{user_id}/settings/password/
@required {user_id: any, body: map}
@returns(204)
@errors {400, 403, 429}

@endgroup

@group view_only_links
@endpoint GET /view_only_links/{link_id}/
@required {link_id: any}
@returns(200)

@endpoint GET /view_only_links/{link_id}/nodes/
@required {link_id: any}
@returns(200)

@endgroup

@group wikis
@endpoint GET /wikis/{wiki_id}/
@required {wiki_id: any}
@returns(200)

@endpoint GET /wikis/{wiki_id}/content/
@required {wiki_id: any}
@returns(200)

@endpoint POST /wikis/{wiki_id}/versions/
@required {wiki_id: any, body: map}
@returns(201)
@errors {400, 401, 403, 404}

@endpoint GET /wikis/{wiki_id}/versions/{version_id}/
@required {wiki_id: any, version_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /wikis/{wiki_id}/versions/{version_id}/content/
@required {wiki_id: any, version_id: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group collections
@endpoint GET /collections/
@returns(200)

@endpoint POST /collections/
@required {body: map}
@returns(201)

@endpoint GET /collections/{collection_id}/
@required {collection_id: any}
@returns(200)

@endpoint DELETE /collections/{collection_id}/
@required {collection_id: any}
@returns(204)

@endpoint GET /collections/{collection_id}/linked_nodes
@required {collection_id: any}
@returns(200)

@endpoint POST /collections/{collection_id}/linked_nodes/relationships/
@required {collection_id: any, body: map}
@returns(201)

@endpoint GET /collections/{collection_id}/linked_nodes/relationships/
@required {collection_id: any}
@returns(200)

@endpoint DELETE /collections/{collection_id}/linked_nodes/relationships/
@required {collection_id: any, body: map}
@returns(200)

@endpoint GET /collections/{collection_id}/linked_registrations/
@required {collection_id: any}
@returns(200)

@endpoint POST /collections/{collection_id}/linked_registrations/relationships/
@required {collection_id: any, body: map}
@returns(201)

@endpoint GET /collections/{collection_id}/linked_registrations/relationships/
@required {collection_id: any}
@returns(200)

@endpoint DELETE /collections/{collection_id}/linked_registrations/relationships/
@required {collection_id: any, body: map}
@returns(200)

@endpoint GET /collections/{collection_id}/linked_preprints/
@required {collection_id: any}
@returns(200)

@endpoint GET /collections/{collection_id}/collected_metadata/
@required {collection_id: any}
@returns(200)

@endpoint POST /collections/{collection_id}/collected_metadata/
@required {collection_id: any, body: map}
@returns(201)

@endpoint GET /collections/{collection_id}/collected_metadata/{cgm_id}
@required {collection_id: any, cgm_id: any}
@returns(200)

@endpoint POST /collections/{collection_id}/collected_metadata/{cgm_id}
@required {collection_id: any, cgm_id: any, body: map}
@returns(201)

@endpoint DELETE /collections/{collection_id}/collected_metadata/{cgm_id}
@required {collection_id: any, cgm_id: any}
@returns(204)

@endpoint GET /collections/{collection_id}/collected_metadata/{cgm_id}/subjects/
@required {collection_id: any, cgm_id: any}
@returns(200)

@endpoint GET /collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/
@required {collection_id: any, cgm_id: any}
@returns(200)

@endpoint POST /collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/
@required {collection_id: any, cgm_id: any, body: map}
@returns(201)

@endgroup

@group providers
@endpoint GET /providers/collections/
@returns(200)

@endpoint GET /providers/collections/{provider_id}/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/collections/{provider_id}/licenses/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/collections/{provider_id}/taxonomies/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/collections/{provider_id}/taxonomies/highlighted/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/collections/{provider_id}/submissions/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/collections/{provider_id}/subjects/highlighted/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/collections/{provider_id}/moderators/
@required {provider_id: any}
@returns(200)

@endpoint GET /providers/collections/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any}
@returns(200)

@endgroup

@group collection_submissions
@endpoint GET /collection_submissions/{collection_submission_id}/actions/
@required {collection_submission_id: any}
@returns(200)

@endgroup

@group collection_submission_actions
@endpoint GET /collection_submission_actions/{collection_submission_id}/
@required {collection_submission_id: any}
@returns(200)

@endpoint POST /collection_submission_actions/
@required {body: map}
@returns(200)

@endgroup

@group provider
@endpoint GET /provider/collections/
@returns(200)

@endpoint GET /provider/collections/{provider_id}/
@required {provider_id: any}
@returns(200)

@endpoint GET /provider/collections/{provider_id}/licenses/
@required {provider_id: any}
@returns(200)

@endpoint GET /provider/collections/{provider_id}/submissions/
@required {provider_id: any}
@returns(200)

@endpoint GET /provider/collections/{provider_id}/subjects/
@required {provider_id: any}
@returns(200)

@endpoint GET /provider/collections/{provider_id}/subjects/highlighted/
@required {provider_id: any}
@returns(200)

@endpoint GET /provider/collections/{provider_id}/moderators/
@required {provider_id: any}
@returns(200)

@endpoint GET /provider/collections/{provider_id}/moderators/{moderator_id}/
@required {provider_id: any, moderator_id: any}
@returns(200)

@endgroup

@group requests
@endpoint GET /requests/{request_id}/
@required {request_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /requests/{request_id}/actions/
@required {request_id: any}
@optional {filter: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group resources
@endpoint GET /resources/
@returns(200)
@errors {401, 403}

@endpoint POST /resources/
@required {body: map}
@returns(201)
@errors {400, 401, 403}

@endpoint GET /resources/{resource_id}/
@required {resource_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /resources/{resource_id}/
@required {resource_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint DELETE /resources/{resource_id}/
@required {resource_id: any}
@returns(204)
@errors {401, 403, 404}

@endgroup

@group subjects
@endpoint GET /subjects/
@optional {filter[text]: any, filter[parent]: any, page: any, page_size: any}
@returns(200)
@errors {400}

@endpoint GET /subjects/{subject_id}/
@required {subject_id: any}
@returns(200)
@errors {404}

@endpoint GET /subjects/{subject_id}/children/
@required {subject_id: any}
@returns(200)
@errors {404}

@endgroup

@group guids
@endpoint GET /guids/{guid_id}/
@required {guid_id: any}
@optional {resolve: any}
@returns(200)
@errors {302, 401, 403, 404, 410}

@endgroup

@group files
@endpoint POST /files/{file_id}/cedar_metadata_records/
@required {file_id: any, body: map}
@returns(201)
@errors {400, 401, 403, 404}

@endgroup

@group nodes
@endpoint POST /nodes/{node_id}/cedar_metadata_records/
@required {node_id: any, body: map}
@returns(201)
@errors {400, 401, 403, 404}

@endgroup

@group custom_file_metadata_records
@endpoint GET /custom_file_metadata_records/{file_id}/
@required {file_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /custom_file_metadata_records/{file_id}/
@required {file_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endgroup

@group custom_item_metadata_records
@endpoint GET /custom_item_metadata_records/{guid_id}/
@required {guid_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /custom_item_metadata_records/{guid_id}/
@required {guid_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endgroup

@group subscriptions
@endpoint GET /subscriptions/
@optional {page: any, filter[event_name]: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /subscriptions/{subscription_id}/
@required {subscription_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /subscriptions/{subscription_id}/
@required {subscription_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endgroup

@group providers
@endpoint GET /providers/collections/{provider_id}/subscriptions/
@required {provider_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/collections/{provider_id}/subscriptions/{subscription_id}/
@required {provider_id: any, subscription_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /providers/collections/{provider_id}/subscriptions/{subscription_id}/
@required {provider_id: any, subscription_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint GET /providers/preprints/{provider_id}/subscriptions/
@required {provider_id: any}
@optional {page: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /providers/preprints/{provider_id}/subscriptions/{subscription_id}/
@required {provider_id: any, subscription_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /providers/preprints/{provider_id}/subscriptions/{subscription_id}/
@required {provider_id: any, subscription_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endpoint GET /providers/registrations/{provider_id}/subscriptions/
@required {provider_id: any}
@optional {page: any}
@returns(200)

@endpoint GET /providers/registrations/{provider_id}/subscriptions/{subscription_id}/
@required {provider_id: any, subscription_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /providers/registrations/{provider_id}/subscriptions/{subscription_id}/
@required {provider_id: any, subscription_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endgroup

@group registration_subscriptions
@endpoint GET /registration_subscriptions/{subscription_id}/
@required {subscription_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /registration_subscriptions/{subscription_id}/
@required {subscription_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endgroup

@group collection_subscriptions
@endpoint GET /collection_subscriptions/{subscription_id}/
@required {subscription_id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint PATCH /collection_subscriptions/{subscription_id}/
@required {subscription_id: any, body: map}
@returns(200)
@errors {400, 401, 403, 404}

@endgroup

@group regions
@endpoint GET /regions/
@returns(200)

@endpoint GET /regions/{region_id}/
@required {region_id: any}
@returns(200)
@errors {404}

@endgroup

@group tokens
@endpoint GET /tokens/
@returns(200)

@endpoint POST /tokens/
@required {body: map}
@returns(201)

@endpoint GET /tokens/{_id}/
@required {_id: any}
@returns(200)
@errors {404}

@endpoint DELETE /tokens/{_id}/
@required {_id: any}
@returns(204)

@endpoint GET /tokens/{_id}/scopes/
@required {_id: any}
@returns(200)
@errors {404}

@endgroup

@group applications
@endpoint GET /applications/
@returns(200)

@endpoint POST /applications/
@required {body: map}
@returns(201)

@endpoint GET /applications/{client_id}/
@required {client_id: any}
@returns(200)

@endpoint PATCH /applications/{client_id}/
@required {client_id: any, body: map}
@returns(200)

@endpoint DELETE /applications/{client_id}/
@required {client_id: any}
@returns(204)

@endpoint POST /applications/{client_id}/reset/
@required {client_id: any}
@returns(201)
@errors {404, 410}

@endgroup

@group scopes
@endpoint GET /scopes/
@returns(200)

@endpoint GET /scopes/{scope_id}/
@required {scope_id: any}
@returns(200)
@errors {404}

@endgroup

@group actions
@endpoint GET /actions/reviews/
@optional {page: any, per_page: any, filter[id]: any, filter[trigger]: any, filter[from_state]: any, filter[to_state]: any, filter[date_created]: any, filter[date_modified]: any}
@returns(200)
@errors {400, 403}

@endpoint POST /actions/requests/nodes/
@required {body: map}
@returns(201)
@errors {400, 403, 409}

@endpoint POST /actions/requests/preprints/
@required {body: map}
@returns(201)
@errors {400, 403, 409}

@endpoint GET /actions/{action_id}/
@required {action_id: any}
@returns(200)
@errors {403, 404}

@endgroup

@group identifiers
@endpoint GET /identifiers/{identifier_id}/
@required {identifier_id: any}
@returns(200)

@endpoint GET /identifiers/{node_id}/identifiers/
@required {node_id: any}
@returns(200)

@endgroup

@end