Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
Nos Hs2023
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Språksamlingane
stadnamn
Nos Hs2023
Commits
e2c58a55
Commit
e2c58a55
authored
4 years ago
by
esikkala
Browse files
Options
Downloads
Patches
Plain Diff
Update API description
parent
40e6c551
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/server/openapi.yaml
+16
-4
16 additions, 4 deletions
src/server/openapi.yaml
with
16 additions
and
4 deletions
src/server/openapi.yaml
+
16
−
4
View file @
e2c58a55
openapi
:
3.0.3
openapi
:
3.0.3
info
:
info
:
title
:
Sampo-UI API
title
:
Sampo-UI API
description
:
Description
description
:
|
This API provides routes for the following search paradigms:
*faceted search*, *full text search*, and *federated full text or spatial search*.
In general the purpose of the API is to
1. convert a request into a SPARQL query using a set of query templates and configurations,
2. run the query against a preconfigured SPARQL endpoint,
3. process the SPARQL results with a preconfigured result mapper, and
4. return them in JSON or CSV format.
The routes related to faceted search accept only POST requests, because the
facet selection arrays may become so large that they need to be delived in the body of the request.
See the schemas for each route for more info about the parameters.
version
:
1.0.0
version
:
1.0.0
servers
:
servers
:
-
url
:
/api/v1
-
url
:
/api/v1
...
@@ -225,7 +237,7 @@ paths:
...
@@ -225,7 +237,7 @@ paths:
description
:
The SPARQL query that was used for the values of the facet
description
:
The SPARQL query that was used for the values of the facet
/{resultClass}/page/{uri}
:
/{resultClass}/page/{uri}
:
post
:
post
:
summary
:
Return information about a single resource
summary
:
Return information about a single resource
, optionally applying facet filters
parameters
:
parameters
:
-
in
:
path
-
in
:
path
name
:
resultClass
name
:
resultClass
...
@@ -298,8 +310,8 @@ paths:
...
@@ -298,8 +310,8 @@ paths:
description
:
The SPARQL query that was used for retrieving the results
description
:
The SPARQL query that was used for retrieving the results
/federated-search
:
/federated-search
:
get
:
get
:
summary
:
Federated search can be used for retrieving the initial result set f
o
r
summary
:
Federated search can be used for retrieving the initial result set fr
om multiple SPARQL
client-side faceted search.
endpoints for
client-side faceted search.
parameters
:
parameters
:
-
in
:
query
-
in
:
query
name
:
dataset
name
:
dataset
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment