From 10e64634ebe1396d9104348bb2f3a5b27a8f1581 Mon Sep 17 00:00:00 2001 From: duyme Date: Thu, 4 Dec 2025 15:00:13 +0100 Subject: [PATCH 1/4] openapi server url with params --- openapi/ver/current/skg-if-openapi.yaml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/openapi/ver/current/skg-if-openapi.yaml b/openapi/ver/current/skg-if-openapi.yaml index dbf3ef7..bc1dd77 100644 --- a/openapi/ver/current/skg-if-openapi.yaml +++ b/openapi/ver/current/skg-if-openapi.yaml @@ -46,7 +46,14 @@ tags: # upper case name description: Pagination description (can use markdown syntax) x-traitTag: true servers: - - url: 'http://example.com/skg-if/api' + - url: 'https://{serv}/{skg_if_api_path}' + variables: + serv: + default: localhost + description: service provider host + skg_if_api_path: + default: skg-if/api + description: service provider skg-if api path paths: '/products/{short_local_identifier}': get: From 3ae4d4e5190918a992886ba322dd82b7d581df14 Mon Sep 17 00:00:00 2001 From: duyme Date: Thu, 4 Dec 2025 15:28:09 +0100 Subject: [PATCH 2/4] openapi server url params --- openapi/ver/current/skg-if-openapi.yaml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/openapi/ver/current/skg-if-openapi.yaml b/openapi/ver/current/skg-if-openapi.yaml index bc1dd77..a7ba208 100644 --- a/openapi/ver/current/skg-if-openapi.yaml +++ b/openapi/ver/current/skg-if-openapi.yaml @@ -46,11 +46,20 @@ tags: # upper case name description: Pagination description (can use markdown syntax) x-traitTag: true servers: - - url: 'https://{serv}/{skg_if_api_path}' + - url: '{protocol}://{server}:{port}/{skg_if_api_path}' variables: - serv: + protocol: + enum: + - "https" + - "http" + default: "https" + description: service provider protocol. + server: default: localhost - description: service provider host + 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 From 32dd036e693cf8beac19990bcaa8e422650d5638 Mon Sep 17 00:00:00 2001 From: duyme Date: Thu, 4 Dec 2025 15:33:44 +0100 Subject: [PATCH 3/4] openapi fix cites and cited_by filter doc --- openapi/ver/current/skg-if-openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/openapi/ver/current/skg-if-openapi.yaml b/openapi/ver/current/skg-if-openapi.yaml index a7ba208..bdb3744 100644 --- a/openapi/ver/current/skg-if-openapi.yaml +++ b/openapi/ver/current/skg-if-openapi.yaml @@ -240,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__ \ From 285ebb7572c854278e5d0a8496ae0571fbf2b216 Mon Sep 17 00:00:00 2001 From: duyme Date: Thu, 4 Dec 2025 15:36:56 +0100 Subject: [PATCH 4/4] openapi server default value --- openapi/ver/current/skg-if-openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi/ver/current/skg-if-openapi.yaml b/openapi/ver/current/skg-if-openapi.yaml index bdb3744..fab69a9 100644 --- a/openapi/ver/current/skg-if-openapi.yaml +++ b/openapi/ver/current/skg-if-openapi.yaml @@ -55,7 +55,7 @@ servers: default: "https" description: service provider protocol. server: - default: localhost + default: example.com description: service provider server. port: default: "8443"