Skip to content

Update citoid docs #1344

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
19 changes: 15 additions & 4 deletions v1/citoid.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,14 @@ paths:
- Citation
summary: Get citation data given an article identifier.
description: |
Generates citation data given a URL, DOI, PMID, or PMCID.
Generates citation data given a URL, DOI, ISBN, PMID, or PMCID.

Automated requests can be made at a rate of 1 request per second (rps).
This service is intended to be used for user initiated requests.

Many websites probibit bot access, so if a bot uses this service on a website which
prohibits bots, this may cause the website to block this service for all users.

Users requesting at a rate greater than 1 request per second (rps) may be blocked.

See more at [Citoid service documentation](https://www.mediawiki.org/wiki/Citoid)

Expand Down Expand Up @@ -53,7 +58,7 @@ paths:
- name: query
in: path
description: |
URL of an article, DOI, PMCID or PMID in the URL-encoded format. Note that on the Swagger-UI doc page you don't need to URI-encode the parameter manually, it will be done by the docs engine.
URL of an article, DOI, ISBN, PMCID or PMID in the URL-encoded format. Note that on the Swagger-UI doc page you don't need to URI-encode the parameter manually, it will be done by the docs engine.
required: true
schema:
type: string
Expand All @@ -74,7 +79,13 @@ paths:
schema:
$ref: '#/components/schemas/result'
404:
description: Citation data was not found.
description: Citation data was not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
415:
description: Could not get citation data from unsupported media type
content:
application/problem+json:
schema:
Expand Down
Loading