< back to docs / api

Use AI to process this documentCopy prompt

system/docs/

This endpoint manages the game's and community's documents, as they are also presented on this service.

  • GET
    • docs/
  • POST
    • docs/module/ creates a new module
    • docs/document/ creates OR updates an existing document => auto-calls API discord/log/
    • docs/log/ creates a new changelog item => auto-calls API discord/log/

Breakdown

GET docs/

Returns list of modules OR documents for specific module OR content of specific document.

  • (*) module_name: when requesting document
    • 404: module not found
  • document_name: use "index" for the module's index document
    • 400: module_name missing
    • 404: module not found

POST docs/module/

Creates a new module.

  • * handler
  • * module_name: max 20 characters
    • 204: module already exists
  • * content: standalone markdown

POST docs/document/

Creates OR updates an existing document.

  • (*) token: when updating
  • * handler
  • * module_name
    • 404: module not found
  • * document_name: use "index" to update a module's index document
    • 204: document cannot be updated
  • * content: standalone markdown

POST docs/log/

Creates a new changelog item.

  • * handler
  • * title: max 20 characters
  • * content: standalone markdown

Notes


< Back to docs / api