Skip to content

OpenAPI server url params #50

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

Merged
rduyme merged 4 commits into from
Dec 4, 2025
Merged

OpenAPI server url params #50

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
10e6463
openapi server url with params
Dec 4, 2025
3ae4d4e
openapi server url params
Dec 4, 2025
32dd036
openapi fix cites and cited_by filter doc
Dec 4, 2025
285ebb7
openapi server default value
Dec 4, 2025
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
26 changes: 21 additions & 5 deletions openapi/ver/current/skg-if-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,23 @@ tags: # upper case name
description: Pagination description (can use markdown syntax)
x-traitTag: true
servers:
- url: 'http://example.com/skg-if/api'
- url: '{protocol}://{server}:{port}/{skg_if_api_path}'
variables:
protocol:
enum:
- "https"
- "http"
default: "https"
description: service provider protocol.
server:
default: example.com
description: service provider server.
port:
default: "8443"
description: service provider port.
skg_if_api_path:
default: skg-if/api
description: service provider skg-if api path
paths:
'/products/{short_local_identifier}':
get:
Expand Down Expand Up @@ -224,10 +240,10 @@ paths:
| cf.contributions_orcid | a string | `product` with contributor with orcid value | `cf.contributions_orcid:0000-0002-1825-0097` |
| cf.contributions_aff_ror | a string | `product` with contributor with declared_affiliations ror value | `cf.contributions_aff_ror:05gq02987` |
| cf.contributions_aff_country | a string | `product` with contributor with declared_affiliations country value | `cf.contributions_aff_country:us` |
| cf.cites | a local_identifier | `product` that cites the `product` having local_identifier filter value | `cf.cites:prod_1` |
| cf.cited_by | a local_identifier | `product` that cites the `product` having local_identifier filter value | `cf.cited_by:prod_1` |
| cf.cites_doi | a doi | `product` that cites the `product` having doi filter value | `cf.cites_doi:10.1038/sdata.2016.18` |
| cf.cited_by_doi | a doi | `product` that cites the `product` having doi filter value | `cf.cited_by_doi:10.1038/sdata.2016.18` |
| cf.cites | a local_identifier | `product` citing the `product` having local_identifier filter value | `cf.cites:prod_1` |
| cf.cited_by | a local_identifier | `product` cited by the `product` having local_identifier filter value | `cf.cited_by:prod_1` |
| cf.cites_doi | a doi | `product` citing the `product` having doi filter value | `cf.cites_doi:10.1038/sdata.2016.18` |
| cf.cited_by_doi | a doi | `product` cited by the `product` having doi filter value | `cf.cited_by_doi:10.1038/sdata.2016.18` |


__Query parameter syntax examples__ \
Expand Down
Loading