popravljen json, swagger, oss_controller, da se ujema z novo strukturo zahtev

This commit is contained in:
Kikimanox
2022-10-19 10:39:30 +02:00
parent 94b04a2922
commit 7682cd0e0a
3 changed files with 255 additions and 114 deletions
+111 -42
View File
@@ -524,7 +524,7 @@
{ {
"name": "leta", "name": "leta",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -536,18 +536,19 @@
{ {
"name": "vrste", "name": "vrste",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "integer",
"format": "int64"
} }
} }
}, },
{ {
"name": "kljucnebesede", "name": "kljucnebesede",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -556,14 +557,13 @@
} }
}, },
{ {
"name": "cerifpodrocja", "name": "udk",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "integer", "type": "string"
"format": "int64"
} }
} }
} }
@@ -588,13 +588,13 @@
"tags": [ "tags": [
"oss" "oss"
], ],
"summary": "Vrne terminloške kandidate glede na ", "summary": "Vrne terminloške kandidate glede na ... (sync)",
"operationId": "getExtractedWords", "operationId": "getExtractedWords",
"parameters": [ "parameters": [
{ {
"name": "leta", "name": "leta",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -606,18 +606,19 @@
{ {
"name": "vrste", "name": "vrste",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "integer",
"format": "int64"
} }
} }
}, },
{ {
"name": "kljucnebesede", "name": "kljucnebesede",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -626,14 +627,13 @@
} }
}, },
{ {
"name": "cerifpodrocja", "name": "udk",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "integer", "type": "string"
"format": "int64"
} }
} }
} }
@@ -655,18 +655,18 @@
} }
} }
}, },
"/oss/datotekePoIskanju": { "/oss/izlusciPoIskanjuAsync": {
"get": { "get": {
"tags": [ "tags": [
"oss" "oss"
], ],
"summary": "Vrne seznam binarnih zapisov v originalnem formatu glede na iskalne pogoje", "summary": "Vrne terminloške kandidate glede na ... (async)",
"operationId": "getFiles", "operationId": "getExtractedWordsAsync",
"parameters": [ "parameters": [
{ {
"name": "leta", "name": "leta",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -678,18 +678,19 @@
{ {
"name": "vrste", "name": "vrste",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "integer",
"format": "int64"
} }
} }
}, },
{ {
"name": "kljucnebesede", "name": "kljucnebesede",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -698,9 +699,43 @@
} }
}, },
{ {
"name": "cerifpodrocja", "name": "udk",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/oss/datotekePoIskanju": {
"get": {
"tags": [
"oss"
],
"summary": "Vrne seznam binarnih zapisov v originalnem formatu glede na iskalne pogoje",
"operationId": "getFiles",
"parameters": [
{
"name": "leta",
"in": "query",
"required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -708,6 +743,40 @@
"format": "int64" "format": "int64"
} }
} }
},
{
"name": "vrste",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "kljucnebesede",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "udk",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
} }
], ],
"responses": { "responses": {
@@ -778,7 +847,7 @@
{ {
"name": "leta", "name": "leta",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -790,18 +859,19 @@
{ {
"name": "vrste", "name": "vrste",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "integer",
"format": "int64"
} }
} }
}, },
{ {
"name": "kljucnebesede", "name": "kljucnebesede",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -810,14 +880,13 @@
} }
}, },
{ {
"name": "cerifpodrocja", "name": "udk",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "integer", "type": "string"
"format": "int64"
} }
} }
} }
@@ -913,7 +982,7 @@
{ {
"name": "leta", "name": "leta",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -925,18 +994,19 @@
{ {
"name": "vrste", "name": "vrste",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "integer",
"format": "int64"
} }
} }
}, },
{ {
"name": "kljucnebesede", "name": "kljucnebesede",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
@@ -945,14 +1015,13 @@
} }
}, },
{ {
"name": "cerifpodrocja", "name": "udk",
"in": "query", "in": "query",
"required": true, "required": false,
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"type": "integer", "type": "string"
"format": "int64"
} }
} }
} }
+40 -22
View File
@@ -3,19 +3,19 @@ from swagger_server import util
from flask import send_file from flask import send_file
def get_conllus(leta, vrste, kljucnebesede, cerifpodrocja): # noqa: E501 def get_conllus(leta=None, vrste=None, kljucnebesede=None, udk=None): # noqa: E501
"""Vrne seznam CoNNL-U-jev glede na iskalne pogoje """"Vrne seznam CoNNL-U-jev glede na iskalne pogoje
# noqa: E501 # noqa: E501
:param leta: :param leta:
:type leta: List[int] :type leta: List[int]
:param vrste: :param vrste:
:type vrste: List[str] :type vrste: List[int]
:param kljucnebesede: :param kljucnebesede:
:type kljucnebesede: List[str] :type kljucnebesede: List[str]
:param cerifpodrocja: :param udk:
:type cerifpodrocja: List[int] :type udk: List[str]
:rtype: List[str] :rtype: List[str]
""" """
@@ -28,18 +28,18 @@ def get_conllus(leta, vrste, kljucnebesede, cerifpodrocja): # noqa: E501
def get_extracted_words(leta=None, vrste=None, kljucnebesede=None, udk=None): # noqa: E501 def get_extracted_words(leta=None, vrste=None, kljucnebesede=None, udk=None): # noqa: E501
"""Vrne terminloške kandidate glede na """Vrne terminloške kandidate glede na ... (sync)
# noqa: E501 # noqa: E501
:param leta: :param leta:
:type leta: List[int] :type leta: List[int]
:param vrste: :param vrste:
:type vrste: List[str] :type vrste: List[int]
:param kljucnebesede: :param kljucnebesede:
:type kljucnebesede: List[str] :type kljucnebesede: List[str]
:param cerifpodrocja: :param udk:
:type cerifpodrocja: List[int] :type udk: List[str]
:rtype: List[TerminoloskiKandidat] :rtype: List[TerminoloskiKandidat]
""" """
@@ -47,8 +47,26 @@ def get_extracted_words(leta=None, vrste=None, kljucnebesede=None, udk=None): #
return files, 200 return files, 200
def get_extracted_words_async(leta=None, vrste=None, kljucnebesede=None, udk=None): # noqa: E501
"""Vrne terminloške kandidate glede na ... (async)
def get_files(leta, vrste, kljucnebesede, cerifpodrocja): # noqa: E501 # noqa: E501
:param leta:
:type leta: List[int]
:param vrste:
:type vrste: List[int]
:param kljucnebesede:
:type kljucnebesede: List[str]
:param udk:
:type udk: List[str]
:rtype: str
"""
return 'do some magic!'
def get_files(leta=None, vrste=None, kljucnebesede=None, udk=None): # noqa: E501
"""Vrne seznam binarnih zapisov v originalnem formatu glede na iskalne pogoje """Vrne seznam binarnih zapisov v originalnem formatu glede na iskalne pogoje
# noqa: E501 # noqa: E501
@@ -56,13 +74,13 @@ def get_files(leta, vrste, kljucnebesede, cerifpodrocja): # noqa: E501
:param leta: :param leta:
:type leta: List[int] :type leta: List[int]
:param vrste: :param vrste:
:type vrste: List[str] :type vrste: List[int]
:param kljucnebesede: :param kljucnebesede:
:type kljucnebesede: List[str] :type kljucnebesede: List[str]
:param cerifpodrocja: :param udk:
:type cerifpodrocja: List[int] :type udk: List[str]
:rtype: List[List[bytearray]] :rtype: str
""" """
if not kljucnebesede: if not kljucnebesede:
return "Manjkajo kljucne besede", 400 return "Manjkajo kljucne besede", 400
@@ -80,15 +98,15 @@ def get_number_texts(leta=None, vrste=None, kljucnebesede=None, udk=None): # no
:param leta: :param leta:
:type leta: List[int] :type leta: List[int]
:param vrste: :param vrste:
:type vrste: List[str] :type vrste: List[int]
:param kljucnebesede: :param kljucnebesede:
:type kljucnebesede: List[str] :type kljucnebesede: List[str]
:param cerifpodrocja: :param udk:
:type udc: List[int] :type udk: List[str]
:rtype: int :rtype: int
""" """
#if not kljucnebesede: # if not kljucnebesede:
# return "Manjkajo kljucne besede", 400 # return "Manjkajo kljucne besede", 400
files = db_utils.vrni_oss_dokumente(leta, vrste, kljucnebesede, udk) files = db_utils.vrni_oss_dokumente(leta, vrste, kljucnebesede, udk)
@@ -103,11 +121,11 @@ def get_texts(leta, vrste, kljucnebesede, cerifpodrocja): # noqa: E501
:param leta: :param leta:
:type leta: List[int] :type leta: List[int]
:param vrste: :param vrste:
:type vrste: List[str] :type vrste: List[int]
:param kljucnebesede: :param kljucnebesede:
:type kljucnebesede: List[str] :type kljucnebesede: List[str]
:param cerifpodrocja: :param udk:
:type cerifpodrocja: List[int] :type udk: List[str]
:rtype: List[str] :rtype: List[str]
""" """
@@ -163,7 +181,7 @@ def oss_besedilo_po_id_get(file_id): # noqa: E501
""" """
try: try:
f = util.get_original_file_path_by_id(file_id) f = util.get_original_file_path_by_id(file_id)
print(f) # for debugging purposes on the server, delete this later print(f) # for debugging purposes on the server, delete this later
return send_file(util.get_original_file_path_by_id(file_id), download_name=f'{file_id}.xml') return send_file(util.get_original_file_path_by_id(file_id), download_name=f'{file_id}.xml')
except FileNotFoundError as e: except FileNotFoundError as e:
return "The file with this ID doesn't exist.", 404 return "The file with this ID doesn't exist.", 404
+95 -41
View File
@@ -343,7 +343,7 @@ paths:
get: get:
tags: tags:
- oss - oss
summary: 'Vrne terminloške kandidate glede na ' summary: Vrne terminloške kandidate glede na ... (sync)
operationId: get_extracted_words operationId: get_extracted_words
parameters: parameters:
- name: leta - name: leta
@@ -395,6 +395,60 @@ paths:
$ref: '#/components/schemas/TerminoloskiKandidat' $ref: '#/components/schemas/TerminoloskiKandidat'
x-content-type: '*/*' x-content-type: '*/*'
x-openapi-router-controller: swagger_server.controllers.oss_controller x-openapi-router-controller: swagger_server.controllers.oss_controller
/oss/izlusciPoIskanjuAsync:
get:
tags:
- oss
summary: Vrne terminloške kandidate glede na ... (async)
operationId: get_extracted_words_async
parameters:
- name: leta
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: integer
format: int64
- name: vrste
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: integer
format: int64
- name: kljucnebesede
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: udk
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
"200":
description: OK
content:
'*/*':
schema:
type: string
x-content-type: '*/*'
x-openapi-router-controller: swagger_server.controllers.oss_controller
/oss/datotekePoIskanju: /oss/datotekePoIskanju:
get: get:
tags: tags:
@@ -491,7 +545,7 @@ paths:
parameters: parameters:
- name: leta - name: leta
in: query in: query
required: true required: false
style: form style: form
explode: true explode: true
schema: schema:
@@ -501,25 +555,7 @@ paths:
format: int64 format: int64
- name: vrste - name: vrste
in: query in: query
required: true required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: kljucnebesede
in: query
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: cerifpodrocja
in: query
required: true
style: form style: form
explode: true explode: true
schema: schema:
@@ -527,6 +563,24 @@ paths:
items: items:
type: integer type: integer
format: int64 format: int64
- name: kljucnebesede
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: udk
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses: responses:
"200": "200":
description: OK description: OK
@@ -595,7 +649,7 @@ paths:
parameters: parameters:
- name: leta - name: leta
in: query in: query
required: true required: false
style: form style: form
explode: true explode: true
schema: schema:
@@ -605,25 +659,7 @@ paths:
format: int64 format: int64
- name: vrste - name: vrste
in: query in: query
required: true required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: kljucnebesede
in: query
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: cerifpodrocja
in: query
required: true
style: form style: form
explode: true explode: true
schema: schema:
@@ -631,6 +667,24 @@ paths:
items: items:
type: integer type: integer
format: int64 format: int64
- name: kljucnebesede
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: udk
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses: responses:
"200": "200":
description: OK description: OK