From a5b63e158c563b24ec5b88919f64009cb0bd56d1 Mon Sep 17 00:00:00 2001 From: Thomas Rubini <74205383+ThomasRubini@users.noreply.github.com> Date: Thu, 16 Feb 2023 12:00:23 +0100 Subject: [PATCH] regenerate docs Co-authored-by: Djalim Simaila --- truthinquiry/templates/doc.html | 708 ++++++++++++++++++++------------ 1 file changed, 451 insertions(+), 257 deletions(-) diff --git a/truthinquiry/templates/doc.html b/truthinquiry/templates/doc.html index cedc029..ab367ff 100644 --- a/truthinquiry/templates/doc.html +++ b/truthinquiry/templates/doc.html @@ -691,7 +691,7 @@ var defs = {} defs["error"] = { "type" : "integer", - "description" : "error de la requette", + "description" : "request error code", "enum" : [ 0, 1 ] }; defs["game"] = { @@ -708,13 +708,13 @@ }, "traits" : { "type" : "array", - "description" : "liste des traits disponible pour cette session de jeu", + "description" : "List of available traits on in this game session", "items" : { "type" : "string" } } }, - "description" : "données du jeu" + "description" : "Main game data, should be queried once" }; defs["gameData"] = { "type" : "object", @@ -729,7 +729,7 @@ }; defs["game_id"] = { "type" : "string", - "description" : "id de la room multijoueur" + "description" : "ID of the game" }; defs["game_npcs"] = { "type" : "object", @@ -750,21 +750,21 @@ "$ref" : "#/components/schemas/npc" } }, - "description" : "liste des personnages choisis par le serveur de maniere aleatoire, ainsi que leur texte de dialogue" + "description" : "List of the randomly chosen npc, with their answer for each type of questions" }; defs["game_questions"] = { "type" : "object", "properties" : { "QA_0" : { "type" : "string", - "description" : "question de type \"oû etait le personnage ?\"" + "description" : "'Where?' type question" }, "QA_1" : { "type" : "string", - "description" : "question de type \"avec qui etait le personnage ?\"" + "description" : "'With who?' type question" } }, - "description" : "les questions identifiés par leur type, choisis aleatoirement par le serveur" + "description" : "Question identified by their type, randomly chosen by the server" }; defs["game_rooms"] = { "type" : "object", @@ -776,10 +776,10 @@ "$ref" : "#/components/schemas/salle" }, "room_id_2" : { - "$ref" : "#/components/schemas/salle_" + "$ref" : "#/components/schemas/salle" } }, - "description" : "object contenant les salle virtuelle de la partie indentifiées par leur identifiants" + "description" : "object storing the virtual rooms that holds the npcs" }; defs["inline_response_200"] = { "type" : "object", @@ -797,7 +797,7 @@ }, "owner" : { "type" : "boolean", - "description" : "booleen determinant si le joueur est le createur de la partie" + "description" : "boolean determining if the palyer is the owner of the gzame" } } }; @@ -853,56 +853,39 @@ "properties" : { "QA_0" : { "type" : "string", - "description" : "reponse a la question \"oû ce personnage etait ?\"" + "description" : "'Where?' type answer" }, "QA_1" : { "type" : "string", - "description" : "reponse a la question \"avec qui ce personnage etait ?\"" + "description" : "'With who?' type answer" }, "name" : { "type" : "string", - "description" : "nom du personnage" + "description" : "npc name" } }, - "description" : "personnage a interroger dans la partie" + "description" : "npc to interogate in the game" }; defs["salle"] = { "type" : "object", "properties" : { "name" : { "type" : "string", - "description" : "nom de la salle virtuelle" + "description" : "virtual room name" }, "npcs" : { "type" : "array", - "description" : "array contenant les identifiants des personnage present dans la salle, cet array contient toujours deux identifiants sauf dans le cas du coupable ou il est seul.", + "description" : "array of the npc_id present in the room, should always be at the number of two, execept for the bulgar who was alone in the room", "items" : { "type" : "string" } } }, - "description" : "object representant une salle virtuelle pour l'intrigue textuelle du jeu" -}; - defs["salle_"] = { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "nom de la salle virtuelle" - }, - "npcs" : { - "type" : "array", - "description" : "array contenant les identifiants des personnage present dans la salle, cet array contient toujours deux identifiants sauf dans le cas du coupable ou il est seul.", - "items" : { - "type" : "integer" - } - } - }, - "description" : "object representant une salle virtuelle pour l'intrigue textuelle du jeu" + "description" : "object representing a single room the the game story" }; defs["username"] = { "type" : "string", - "description" : "pseudo du joueur" + "description" : "player username" }; defs["v1_createGame_body"] = { "type" : "object", @@ -915,7 +898,7 @@ defs["v1_getNpcImage_body"] = { "type" : "object", "properties" : { - "npcid" : { + "image_id" : { "type" : "integer" } } @@ -979,6 +962,9 @@
  • invite
    • +
  • + mentionLegales +
  • multiPage
    • @@ -1010,12 +996,12 @@

    createGame

    -

    Demande une nouvelle session de jeu multijoueur au serveur

    +

    Create a game session

    -

    Cette route crée une salle de jeu multijoueur dans le serveur, elle octroie ensuite les droit de creation de la salle a l'utilisateur dont le pseudo est donné en parametre post et lui retourne l'identifiant de la game

    +

    This endpoint create a game in the server, the username passed as parametter is set as the game owner


    /api/v1/createGame
    @@ -1057,7 +1043,7 @@ public class ApiApiExample { public static void main(String[] args) { ApiApi apiInstance = new ApiApi(); - V1_createGame_body body = ; // V1_createGame_body | Le pseudo de la personne souhaitant crée une partie + V1_createGame_body body = ; // V1_createGame_body | username to set as game owner try { newGameData result = apiInstance.createGame(body); System.out.println(result); @@ -1076,7 +1062,7 @@ public class ApiApiExample { public static void main(String[] args) { ApiApi apiInstance = new ApiApi(); - V1_createGame_body body = ; // V1_createGame_body | Le pseudo de la personne souhaitant crée une partie + V1_createGame_body body = ; // V1_createGame_body | username to set as game owner try { newGameData result = apiInstance.createGame(body); System.out.println(result); @@ -1092,11 +1078,11 @@ public class ApiApiExample { 
    Coming Soon!
    -->
    - 
    V1_createGame_body *body = ; // Le pseudo de la personne souhaitant crée une partie
+                              
    V1_createGame_body *body = ; // username to set as game owner
 
 ApiApi *apiInstance = [[ApiApi alloc] init];
 
-// Demande une nouvelle session de jeu multijoueur au serveur
+// Create a game session
 [apiInstance createGameWith:body
               completionHandler: ^(newGameData output, NSError* error) {
                             if (output) {
@@ -1113,7 +1099,7 @@ ApiApi *apiInstance = [[ApiApi alloc] init];
                               
    var TruthInquiry = require('truth_inquiry');
 
 var api = new TruthInquiry.ApiApi()
-var body = ; // {{V1_createGame_body}} Le pseudo de la personne souhaitant crée une partie
+var body = ; // {{V1_createGame_body}} username to set as game owner
 
 var callback = function(error, data, response) {
   if (error) {
@@ -1144,11 +1130,11 @@ namespace Example
         {
 
             var apiInstance = new ApiApi();
-            var body = new V1_createGame_body(); // V1_createGame_body | Le pseudo de la personne souhaitant crée une partie
+            var body = new V1_createGame_body(); // V1_createGame_body | username to set as game owner
 
             try
             {
-                // Demande une nouvelle session de jeu multijoueur au serveur
+                // Create a game session
                 newGameData result = apiInstance.createGame(body);
                 Debug.WriteLine(result);
             }
@@ -1167,7 +1153,7 @@ namespace Example
 require_once(__DIR__ . '/vendor/autoload.php');
 
 $api_instance = new Swagger\Client\ApiApiApi();
-$body = ; // V1_createGame_body | Le pseudo de la personne souhaitant crée une partie
+$body = ; // V1_createGame_body | username to set as game owner
 
 try {
     $result = $api_instance->createGame($body);
@@ -1184,7 +1170,7 @@ use WWW::SwaggerClient::Configuration;
 use WWW::SwaggerClient::ApiApi;
 
 my $api_instance = WWW::SwaggerClient::ApiApi->new();
-my $body = WWW::SwaggerClient::Object::V1_createGame_body->new(); # V1_createGame_body | Le pseudo de la personne souhaitant crée une partie
+my $body = WWW::SwaggerClient::Object::V1_createGame_body->new(); # V1_createGame_body | username to set as game owner
 
 eval { 
     my $result = $api_instance->createGame(body => $body);
@@ -1204,10 +1190,10 @@ from pprint import pprint
 
 # create an instance of the API class
 api_instance = swagger_client.ApiApi()
-body =  # V1_createGame_body | Le pseudo de la personne souhaitant crée une partie
+body =  # V1_createGame_body | username to set as game owner
 
 try: 
-    # Demande une nouvelle session de jeu multijoueur au serveur
+    # Create a game session
     api_response = api_instance.create_game(body)
     pprint(api_response)
 except ApiException as e:
@@ -1232,7 +1218,7 @@ except ApiException as e: