Skip to content
Snippets Groups Projects
Commit f0fd4630 authored by Ole Voldsæter's avatar Ole Voldsæter
Browse files

mer dokumentasjon

parent 39c411e9
No related branches found
No related tags found
No related merge requests found
{
"openapi": "3.0.1",
"info": {
"title": "ordbok-cache",
"version": "2020-02-17T12:44:25Z"
"title": "Dictionary JSON API",
"description": "This API is developed by the University of Bergen. Its purpose is to serve the new national dictionary website wich is under development. API keys are available upon request. No warranty.",
"version": "beta"
},
"servers": [
{
......@@ -17,6 +18,7 @@
"name": "dict_id",
"in": "path",
"required": true,
"description": "Dictionary code, 'bob' for bokmål, 'nob' for nynorsk",
"schema": {
"type": "string"
}
......@@ -26,7 +28,7 @@
"in": "path",
"required": true,
"schema": {
"type": "string"
"type": "integer"
}
}
],
......@@ -50,10 +52,13 @@
}
},
"/article/{dict_id}/search": {
"summary": "Search for a word",
"description": "Search for words as an article lemmas, or words occurring in certain article elements. For instance, old norse _fljúga_ will match the article for modern Norwegian verb _fly_ (meaning to fly)",
"get": {
"parameters": [
{
"name": "dict_id",
"description": "Dictionary to search, 'bob' for bokmål, 'nob' for nynorsk, 'bob,bob' for both",
"in": "path",
"required": true,
"schema": {
......@@ -62,6 +67,7 @@
},
{
"name": "q",
"description": "Query string",
"in": "query",
"required": true,
"schema": {
......@@ -90,9 +96,12 @@
},
"/article/{dict_id}/suggest": {
"get": {
"summary": "Get autocomplete suggestions for a prefix",
"description": "Returns articles for words that begin with the prefix specified in query string 'q'",
"parameters": [
{
"name": "dict_id",
"description": "Dictionary to search, 'bob' for bokmål, 'nob' for nynorsk, 'bob,bob' for both",
"in": "path",
"required": true,
"schema": {
......@@ -101,6 +110,7 @@
},
{
"name": "q",
"description": "Query string: prefix for autocomplete",
"in": "query",
"required": true,
"schema": {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment