Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Thoth Search UI URL to response headers #1722

Merged
merged 2 commits into from
Mar 23, 2022
Merged

Add Thoth Search UI URL to response headers #1722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65a9716
Add Thoth Search UI URL to response headers
mayaCostantini Mar 21, 2022
f89d1ae
Apply search ui url header to each response
mayaCostantini Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -73,6 +75,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -104,6 +108,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -210,6 +216,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -252,6 +260,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -482,6 +492,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -518,6 +530,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -570,6 +584,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
page:
$ref: "#/components/headers/page"
per_page:
Expand Down Expand Up @@ -613,6 +629,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -655,6 +673,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -698,6 +718,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -894,6 +916,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand All @@ -912,6 +936,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -941,6 +967,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand Down Expand Up @@ -976,6 +1004,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
page:
$ref: "#/components/headers/page"
per_page:
Expand Down Expand Up @@ -1013,6 +1043,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
page:
$ref: "#/components/headers/page"
per_page:
Expand Down Expand Up @@ -1058,6 +1090,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand All @@ -1083,6 +1117,8 @@ paths:
$ref: "#/components/headers/x-thoth-version"
x-user-api-service-version:
$ref: "#/components/headers/x-user-api-service-version"
x-thoth-search-ui-url:
$ref: "#/components/headers/x-thoth-search-ui-url"
content:
application/json:
schema:
Expand All @@ -1103,7 +1139,7 @@ paths:
tags: [PythonPackages]
x-openapi-router-controller: thoth.user_api.api_v1
operationId: get_package_from_imported_packages
summary: List imported packages' (name, version, index)
summary: List imported packages (name, version, index)
parameters:
- $ref: "#/components/parameters/import_name"
responses:
Expand Down Expand Up @@ -1524,6 +1560,11 @@ components:
schema:
type: string
example: 1.0.0+messaging.1.1.0.storages.1.2.0.common.1.3.0.python.1.4.0
x-thoth-search-ui-url:
description: Thoth Search UI URL
schema:
type: string
example: https://thoth-station.ninja/search/
page:
description: Current page
schema:
Expand Down
2 changes: 2 additions & 0 deletions thoth/user_api/openapi_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
_THOTH_API_HTTPS = bool(int(os.getenv("THOTH_API_HTTPS", 1)))
_REPORT_EXCEPTIONS = bool(int(os.getenv("THOTH_API_REPORT_EXCEPTIONS", 0)))
_MAX_POST_CONTENT_LENGTH = int(os.getenv("THOTH_MAX_POST_CONTENT_LENGTH", 3 * 1024 * 1024)) # 3MiB by default.
THOTH_SEARCH_UI_URL = os.getenv("THOTH_SEARCH_UI_URL", "https://thoth-station.ninja/search/")

# Expose for uWSGI.
app = connexion.FlaskApp(__name__, specification_dir=Configuration.SWAGGER_YAML_PATH, debug=True)
Expand Down Expand Up @@ -328,6 +329,7 @@ def apply_headers(response):
"""Add headers to each response."""
response.headers["X-Thoth-Version"] = __version__
response.headers["X-User-API-Service-Version"] = __service_version__
response.headers["X-Thoth-Search-Ui-Url"] = THOTH_SEARCH_UI_URL
if "page" in response.headers:
# Expose headers to users.
response.headers["Access-Control-Expose-Headers"] = "page,entries_count,next,page_count,per_page,prev"
Expand Down