Mirrorlandia_minetest/contentdb
1
0
Fork 0
mirror of https://github.com/minetest/contentdb.git synced 2024-12-23 22:42:25 +01:00
Code Issues Packages Projects Releases Wiki Activity
1b1c94ffa0
contentdb/app/flatpages/help/api.md
rubenwardy 4ce388c8aa Add API Token creation
2019-11-27 01:06:58 +00:00

1.5 KiB
Raw Blame History

title: API

Authentication

Not all endpoints require authentication. Authentication is done using Bearer tokens:

Authorization: Bearer YOURTOKEN

You can use the /api/whoami to check authentication.

Endpoints

Misc

  • GET /api/whoami/ - Json dictionary with the following keys:
    • is_authenticated - True on successful API authentication
    • username - Username of the user authenticated as, null otherwise.
    • 403 will be thrown on unsupported authentication type, invalid access token, or other errors.

Packages

  • GET /api/packages/ - See Package Queries
  • GET /api/packages/<username>/<name>/

Topics

  • GET /api/topics/ - Supports Package Queries, and the following two options:
    • show_added - Show topics which exist as packages, default true.
    • show_discarded - Show topics which have been marked as outdated, default false.

Minetest

  • GET /api/minetest_versions/

Package Queries

Example:

/api/packages/?type=mod&type=game&q=mobs+fun&hide=nonfree&hide=gore

Supported query parameters:

  • type - Package types (mod, game, txp).
  • q - Query string
  • random - When present, enable random ordering and ignore sort.
  • hide - Hide content based on Content Flags.
  • sort - Sort by (name, views, date, score).
  • order - Sort ascending (Asc) or descending (desc).
  • protocol_version - Only show packages supported by this Minetest protocol version.