edubridge learning management system
GET /api/v1/info

Get general information about the API including available endpoints

Responses

  • 200 application/json

    API information

    Hide response attributes Show response attributes object
    • name string Required

      Service name

    • description string Required

      Service description

    • version string Required

      Service version

    • author string Required

      Service author

    • license string Required

      Service license

    • documentation string Required

      API documentation URL

    • endpoints object Required

      Available API endpoints

      Hide endpoints attributes Show endpoints attributes object
      • health string Required

        Health check endpoint

      • status string Required

        Status endpoint

      • info string Required

        Info endpoint

      • uptime string Required

        Uptime endpoint

      • version string Required

        Version endpoint
  • 400 application/json

    Default bad request error 400 response

    Hide response attributes Show response attributes object
    • message string Required

      Response message

    • error string Required
    • statusCode number Required
GET /api/v1/info 
curl \
 --request GET 'http://localhost:3500/api/v1/info'
Response examples (200) 
{
  "name": "Edubridge Learning Management System",
  "description": "A modular scalable secure learning management system",
  "version": "1.0.0",
  "author": "Kahuho Charles",
  "license": "UNLICENSED",
  "documentation": "/api/docs",
  "endpoints": {
    "health": "/health",
    "status": "/status",
    "info": "/info",
    "uptime": "/uptime",
    "version": "/version"
  }
}
Response examples (400) 
{
  "message": "string",
  "error": "string",
  "statusCode": 42.0
}