diff --git a/api_static/api/swagger.json b/api_static/api/swagger.json index 52dca8259dee7444d8ad6d2e4506912017149166..2e31b9f827e9734a560832dffbd251889c004daa 100644 --- a/api_static/api/swagger.json +++ b/api_static/api/swagger.json @@ -1,7 +1,7 @@ { "openapi": "3.0.1", "info": { - "title": "Dictionary JSON API", + "title": "Ordbok 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" }, @@ -14,7 +14,7 @@ "/article/{dict_id}/{art_id}": { "get": { "summary": "Article lookup", - "description": "Returns an article with a specific numerical ID", + "description": "Returns an article with a specific numeric ID", "parameters": [ { "name": "dict_id", @@ -23,16 +23,18 @@ "description": "Dictionary code, 'bob' for bokmål, 'nob' for nynorsk", "schema": { "type": "string" - } + }, + "example": "bob" }, { "name": "art_id", "in": "path", "required": true, - "description": "The numerical ID of an article", + "description": "The numeric ID of an article", "schema": { "type": "integer" - } + }, + "example": 15544 } ], "security": [