Mirrorlandia_minetest/contentdb
1
0
Fork 0
mirror of https://github.com/minetest/contentdb.git synced 2024-12-23 06:22:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Package API: Add option to return desc as hypertext

Browse Source
This commit is contained in:
rubenwardy 2023-12-16 00:46:11 +00:00
parent e6bba7d8a2
commit 8606f596f3
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
app/blueprints/api/endpoints.py
View File

@ -33,11 +33,11 @@ from app.models import Tag, PackageState, PackageType, Package, db, PackageRelea
PackageAlias PackageAlias
from app.querybuilder import QueryBuilder from app.querybuilder import QueryBuilder
from app.utils import is_package_page, get_int_or_abort, url_set_query, abs_url, is_yes, get_request_date from app.utils import is_package_page, get_int_or_abort, url_set_query, abs_url, is_yes, get_request_date
from app.utils.minetest_hypertext import html_to_minetest
from . import bp from . import bp
from .auth import is_api_authd from .auth import is_api_authd
from .support import error, api_create_vcs_release, api_create_zip_release, api_create_screenshot, \ from .support import error, api_create_vcs_release, api_create_zip_release, api_create_screenshot, \
api_order_screenshots, api_edit_package, api_set_cover_image api_order_screenshots, api_edit_package, api_set_cover_image
from app.utils.minetest_hypertext import html_to_minetest
def cors_allowed(f): def cors_allowed(f):
@ -99,7 +99,14 @@ def packages():
@is_package_page @is_package_page
@cors_allowed @cors_allowed
def package_view(package): def package_view(package):
return jsonify(package.as_dict(current_app.config["BASE_URL"])) data = package.as_dict(current_app.config["BASE_URL"])
if "formspec_version" in request.args:
formspec_version = request.args["formspec_version"]
include_images = is_yes(request.args.get("include_images", "true"))
html = render_markdown(package.desc)
data["long_description"] = html_to_minetest(html, formspec_version, include_images)
return jsonify(data)
@bp.route("/api/packages/<author>/<name>/hypertext/") @bp.route("/api/packages/<author>/<name>/hypertext/")

3
app/flatpages/help/api.md
View File

@ -78,6 +78,9 @@ curl -X DELETE https://content.minetest.net/api/delete-token/ \
* GET `/api/packages/` (List) * GET `/api/packages/` (List)
* See [Package Queries](#package-queries) * See [Package Queries](#package-queries)
* GET `/api/packages/<username>/<name>/` (Read) * GET `/api/packages/<username>/<name>/` (Read)
* Query arguments
* `formspec_version`: Optional. If present, `long_description` is returned a hypertext (see /hypertext/ below).
* `include_images`: Optional, defaults to true. Only used if `formspec_version` is provided.
* PUT `/api/packages/<author>/<name>/` (Update) * PUT `/api/packages/<author>/<name>/` (Update)
* Requires authentication. * Requires authentication.
* JSON dictionary with any of these keys (all are optional, null to delete Nullables): * JSON dictionary with any of these keys (all are optional, null to delete Nullables):