From 1fa525c9235a038535a231c383603a8fa21964e6 Mon Sep 17 00:00:00 2001
From: feger <marc.feger@hhu.de>
Date: Tue, 3 Sep 2019 20:08:48 +0200
Subject: [PATCH] Update docs :books:
---
flask/doc/swagger-ui/index.html | 2 +-
.../{swagger_documentation.yaml => docs.yaml} | 12 ++++--------
2 files changed, 5 insertions(+), 9 deletions(-)
rename flask/static/swagger/{swagger_documentation.yaml => docs.yaml} (83%)
diff --git a/flask/doc/swagger-ui/index.html b/flask/doc/swagger-ui/index.html
index d4313c2..553800c 100755
--- a/flask/doc/swagger-ui/index.html
+++ b/flask/doc/swagger-ui/index.html
@@ -36,7 +36,7 @@
window.onload = function () {
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
- url: "../static/swagger/swagger_documentation.yaml",
+ url: "../static/swagger/docs.yaml",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
diff --git a/flask/static/swagger/swagger_documentation.yaml b/flask/static/swagger/docs.yaml
similarity index 83%
rename from flask/static/swagger/swagger_documentation.yaml
rename to flask/static/swagger/docs.yaml
index f1b4950..691a37f 100644
--- a/flask/static/swagger/swagger_documentation.yaml
+++ b/flask/static/swagger/docs.yaml
@@ -1,6 +1,6 @@
openapi: 3.0.0
servers:
- - url: 'http://0.0.0.0:5000/'
+ - url: 'http://localhost:5000/'
info:
version: "1.0"
title: D-BASearch
@@ -8,19 +8,15 @@ info:
paths:
/search:
get:
- summary: Assemble the DBPedia groundtruth with english labels.
- description: >-
- This function assembles the groundtruth of DBPedia.
- It searches for all Comedy Films which have at least one director who is born after or on 1970.
- This is done in more then one step and may take a while. 1-2 Minutes.
+ summary: Fuzzy-search for textversions.
tags:
- - DBPedia
+ - search
parameters:
- in: query
name: q
schema:
type: string
- description: The number of items to skip before starting to collect the result set
+ description: Text to be searched for.
responses:
200:
description: OK
--
GitLab