User Tools

Site Tools


mtr:development:api_reference

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
mtr:development:api_reference [2024/05/25 20:34] – Added a list to pages Jonathan Homtr:development:api_reference [2026/06/29 15:26] (current) – Add removal notice AmberFrost
Line 1: Line 1:
 ====== API Reference ====== ====== API Reference ======
-These docs apply to Minecraft Transit Railway 4.0.0 and above.+ 
 +These docs apply to Minecraft Transit Railway 4.0.0 beta. 
 + 
 +**NOTE: After various development in the beta phase, the HTTP API has been removed as of the official MTR 4.0.0 release. All operation endpoint mentioned in this page is no longer applicable.** 
 ===== Schema Information ===== ===== Schema Information =====
 +
 Each endpoint's schema is linked in their own page. See the [[https://github.com/Minecraft-Transit-Railway/Transport-Simulation-Core/tree/master/buildSrc/src/main/resources/schema|Transport Simulation Core]] project for all schemas. Each endpoint's schema is linked in their own page. See the [[https://github.com/Minecraft-Transit-Railway/Transport-Simulation-Core/tree/master/buildSrc/src/main/resources/schema|Transport Simulation Core]] project for all schemas.
 +
 ===== Request Format ===== ===== Request Format =====
 +
   * The examples on this wiki assume that the server IP is ''localhost'' with port ''8888''.   * The examples on this wiki assume that the server IP is ''localhost'' with port ''8888''.
   * For POST requests, example request bodies are attached.   * For POST requests, example request bodies are attached.
   * For most requests, the dimension can be specified by adding ''?dimension=<dimensionId>'' at the end of the endpoint URL (e.g. ''0'' for overworld, ''1'' for nether).   * For most requests, the dimension can be specified by adding ''?dimension=<dimensionId>'' at the end of the endpoint URL (e.g. ''0'' for overworld, ''1'' for nether).
 +
 ===== Helpful Information ===== ===== Helpful Information =====
 +
   * Rail IDs are comprised of six numbers  (converted to hex strings) corresponding to the rail's node positions. It is in the format of ''<x1>-<y1>-<z1>-<x2>-<y2>-<z2>''.   * Rail IDs are comprised of six numbers  (converted to hex strings) corresponding to the rail's node positions. It is in the format of ''<x1>-<y1>-<z1>-<x2>-<y2>-<z2>''.
 +
 ===== API List ===== ===== API List =====
 +
 <nspages mtr:development:api_reference -textPages="" -title -exclude> <nspages mtr:development:api_reference -textPages="" -title -exclude>
 +
 +
mtr/development/api_reference.txt · Last modified: 2026/06/29 15:26 by AmberFrost