api.raml 19.8 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
#%RAML 0.8
title: API d'Etunicorn
baseUri: https://etunicorn.plil.net/{version}/
version: v1
# Les codes 400 sont implicites
/login:
  post:
    description: Instancie une nouvelle connexion
    body:
        application/json:
            schema: |
                {
                "type": "object",
                "$schema": "http://json-schema.org/draft-03/schema",
                "id": "http://jsonschema.net",
                "required": true,
                "properties": {
                    "login": {
                        "type": "string",
                        "required": true
                    },
                    "password": {
                        "type": "string",
                        "required": true
                    }
                }
                }
    responses:
      200:
        description: Authentification réussie
        body:
          application/json:
            example: |
              {
                "token": "ooT6zahdura7vaethuiph1ugiph6co",
                "expire": 1485607703,
                "role": "admin",
                "permissions": [
                  {
                    "nom": "CREER_EVNMT"
                  },
                  {
                    "nom": "SUPPRIMER_EVNMT"
                  }
                ]
              }
      401:
        description: Authentication échouée
  /{token}:
    delete:
      description: Se déconnecter
      responses:
        204:
          description: Déconnecté avec succès
        404:
          description: Jeton non trouvé
/personne:
  get:
    description: Obtenir la liste des persones. Nécessite COMPTE_ADMIN
    responses:
      200:
        body:
          application/json:
            example: |
              [
               {
                  "id": 42,
                  "carte": "AAAAA",
                  "naissance": "855874800000",
                  "solde": 1337,
                  "login": "gbontoux",
                  "role": "etudiant"
                }
              ]
  /{idPersonne}:
    uriParameters:
      idPersonne:
        type: number
        required: true
        description: ID de la personne
        minimum: 0
    get:
      description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN
      responses:
        200:
          description: Utilisateur récupéré
          body:
            application/json:
              example: |
               {
                  "id": 42,
                  "carte": "AAAAA",
                  "naissance": "855874800000",
                  "solde": 1337,
                  "login": "gbontoux",
                  "role": "etudiant"
                }
        404:
          description: Utilisateur non trouvé
    put:
      description: Modifer les infos d'une personne. Nécessite COMPTE_ADMIN
      body:
          application/json:
            schema: |
                {
                  "type": "object",
                  "$schema": "http://json-schema.org/draft-03/schema",
                  "id": "http://jsonschema.net",
                  "required": true,
                  "properties": {
                      "carte": {
                          "type": "string",
                          "required": false,
                          "minLength": 14,
                          "maxLength": 14
                      },
                      "naissance": {
                          "type": "date",
                          "required": false
                      },
                      "login": {
                        "type": "string",
                        "required": false
                      },
                      "role": {
                        "type": "role",
                        "required": false
                    }
                  }
                }
      responses:
        202:
          description: Utilisateur modifié
        404:
          description: Utilisateur non trouvé
    delete:
      description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN
      responses:
        204:
          description: Utilisateur supprimé
        404:
          description: Utilisateur non trouvé
  post:
    description: Ajoute une nouvelle personne
    body:
      application/json:
          schema: |
              {
              "type": "object",
              "$schema": "http://json-schema.org/draft-03/schema",
              "id": "http://jsonschema.net",
              "required": true,
              "properties": {
                  "carte": {
                      "type": "string",
                      "required": false,
                      "minLength": 14,
                      "maxLength": 14
                  },
                  "naissance": {
                      "type": "date",
                      "required": false
                  },
                  "login": {
                    "type": "string",
                    "required": false
                  },
                  "role": {
                    "type": "role",
                    "required": false
                }
              }
              }
    responses:
      201:
        description: Personne ajoutée avec succès
        body:
          application/json:
            example: |
              {
                "id": 42
              }
/role:
  get:
    description: Liste les rôles. Nécessite ROLE_ADMIN
    responses:
      200:
        body:
          application/json:
            example: |
              [
                {
                  "nom": "etudiant",
                  "permissions": []
                },
                {
                  "nom": "bde",
                    "permissions": [
                    {
                      "nom": "CREER_EVNMT"
                    },
                    {
                      "nom": "SUPPRIMER_EVNMT"
                    }
                  ]
                }
              ]
  post:
    description: Ajoute un nouveau rôle. Nécessite ROLE_ADMIN
    body:
      application/json:
        schema: |
              {
              "type": "object",
              "$schema": "http://json-schema.org/draft-03/schema",
              "id": "http://jsonschema.net",
              "required": true,
              "properties": {
                  "nom": {
                      "type": "string",
                      "required": true,
                      "minLength": 3
                  }
              }
              }
    responses:
      201:
        description: Rôle créé avec succès
      409:
        description: Un rôle avec le même nom existe déjà
  /{nomRole}:
    uriParameters:
      nomRole:
        type: number
        required: true
        description: ID du role
        minimum: 0
    delete:
      description: Supprime un rôle. Nécessite ROLE_ADMIN
      responses:
        204:
          description: Rôle supprimé
        404:
          description: Rôle inconnu
    post:
      description: Ajoute une permission à un rôle. Nécessite ROLE_ADMIN
      body:
        application/json:
          schema: |
            {
            "type": "object",
            "$schema": "http://json-schema.org/draft-03/schema",
            "id": "http://jsonschema.net",
            "required": true,
            "properties": {
                "nom": {
                    "type": "string",
                    "required": true
                }
            }
            }
      responses:
        201:
          description: Permission ajouté avec succès
        404:
          description: Permission ou rôle inconnu
    /{nomPermission}:
      uriParameters:
        nomPermission:
          type: string
          required: true
          description: nom de la permission
      delete:
        description: Enlève la permission du rôle. Nécessite ROLE_ADMIN
        responses:
          204:
            description: Permission enlevée avec succès
          404:
            description: Permission ou rôle inconnu
  /permission:
    get:
      description: Liste les permissions. Nécessite ROLE_ADMIN
      responses:
        200:
          body:
            application/json:
              example: |
                [
                  {
                    "nom": "CREER_EVNMT"
                  },
                  {
                    "nom": "SUPPRIMER_EVNMT"
                  }
                ]
/evenement:
  get:
    description: Obtenir la liste de tout les evenements. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER
    responses:
      200:
        body:
          application/json:
            example: |
              [
                {
                  "id": 1,
                  "nom": "patate",
                  "prix": 4,
                  "date": "2001-09-11"
                },
                {
                  "id": 2,
                  "nom": "patate flambe",
                  "prix": 5,
                  "date": "2001-09-11"
                }
              ]
  post:
    description: Permet de creer un nouvel evenement. Nécessite EVNMT_ADMIN
    body:
      application/json:
        schema: |
            {
            "type": "object",
            "$schema": "http://json-schema.org/draft-03/schema",
            "id": "http://jsonschema.net",
            "required": true,
            "properties": {
                "nom": {
                    "type": "string",
                    "required": true
                },
                "prix": {
                    "type": "number",
                    "required": true
                },
                "date": {
                    "type": "date",
                    "required": true
                }
            }
            }
    responses:
      201:

  /{evenementId}:
    uriParameters:
        evenementId:
          type: integer
          required: true
          description: id de l'evenement
          minimum: 0
    put:
      description: Permet de modifier un évènement existant. Nécessite EVNMT_ADMIN
      body:
        application/json:
          schema: |
              {
              "type": "object",
              "$schema": "http://json-schema.org/draft-03/schema",
              "id": "http://jsonschema.net",
              "required": true,
              "properties": {
                  "nom": {
                      "type": "string",
                      "required": false
                  },
                  "prix": {
                      "type": "number",
                      "required": false
                  },
                  "date": {
                      "type": "date",
                      "required": false
                  }
              }
              }
      responses:
        202:
          description: Modification pris en compte
        404:
          description: L'evenement n'existe pas
    get:
      description: Obtenir l'evenement {evenementId}. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER
      responses:
        200:
          body:
            application/json:
              example: |
                [
                   {
                    "id": 1,
                    "nom": "patate",
                    "prix": 4,
                    "date": "2001-09-11"
                  }
                ]
        404:
          description: Evenement non existant
    delete:
      description: Permet de supprimer l'evenement {evenementId}. Nécessite EVNMT_ADMIN
      responses:
        200:
          description: L'evenement a été bien supprimé
    /participe:
      post:
        description: Permet de notifier que quelqu'un a participer à l'evenement (id de la personne a envoyer)
        body:
          application/json:
            schema: |
                {
                "type": "object",
                "$schema": "http://json-schema.org/draft-03/schema",
                "id": "http://jsonschema.net",
                "required": true,
                "properties": {
                    "id": {
                        "type": "integer",
                        "required": true
                    }
                }
                }
        responses:
          201:
            description: La personne est bien inscrite a cet evenement ou a bien était ajouté a la liste des participant
          402:
            description: La personne n'a pas payé pour participer à l'evenement
/consommation:
  get:
    description: Obtenir la liste de toutes les consommations. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER
    responses:
      200:
        body:
          application/json:
            example: |
              [
                {
                  "id": 1,
                  "nom": "juis de fruit",
                  "prix": 4
                },
                {
                  "id": 2,
                  "nom": "juis de fruit flambe",
                  "prix": 5
                }
              ]
  post:
    description: Permet de creer une nouvelle consommation. Nécessite CONSO_ADMIN
    body:
      application/json:
        schema: |
          {
          "type": "object",
          "$schema": "http://json-schema.org/draft-03/schema",
          "id": "http://jsonschema.net",
          "required": true,
          "properties": {
              "nom": {
                  "type": "string",
                  "required": true
              },
              "prix": {
                  "type": "number",
                  "required": true
              }
          }
          }
    responses:
      201:
  /{consommationId}:
    uriParameters:
      consommationId:
        type: integer
        required: true
        description: id de la consommation
        minimum: 0
    put:
      description: Permet de modifier une consommation. Nécessite CONSO_ADMIN
      body:
          application/json:
            schema: |
                {
                "type": "object",
                "$schema": "http://json-schema.org/draft-03/schema",
                "id": "http://jsonschema.net",
                "required": true,
                "properties": {
                    "nom": {
                        "type": "string",
                        "required": false
                    },
                    "prix": {
                        "type": "number",
                        "required": false
                    }
                }
                }
      responses:
        202:
          description: Modification pris en compte
        404:
          description: L'evenement n'existe pas
    get:
      description: Obtenir la consommation {consommationId}. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER
      responses:
        200:
          body:
            application/json:
              example: |
                [
                   {
                    "id": 1,
                    "nomEvenement": "patate",
                    "prix": 4,
                    "date": "2001-09-11"
                  }
                ]
        404:
          description: consommation non existante
    delete:
      description: Permet de supprimer la consommation {consommationId}. Nécessite CONSO_ADMIN
      responses:
        200:
          description: La consommation a été bien supprime

/transaction:
  get:
    description: Permet de recuperer la liste des transaction
    responses:
      200:
        description: On recupere la liste des transactions
        body:
          application/json:
            example: |
              [
                {
                  "participant": 1,
                  "acteur": 18,
                  "idTransaction": 42,
                  "type": true,
                  "date": "2003-12-01",
                  "prix": 25.23
                },
                {
                  "participant": 5,
                  "acteur": 1,
                  "idTransaction": 43,
                  "type": true,
                  "date": "2003-12-01",
                  "prix": -25.23
                }
              ]
  /consommation:
    post:
      description: Achat d'une consomation (id) par un participant à un acteur
      body:
        application/json:
          schema: |
            {
            "type": "object",
            "$schema": "http://json-schema.org/draft-03/schema",
            "id": "http://jsonschema.net",
            "required": true,
            "properties": {
              "participant": {
                "type": "Personne",
                "required": true
              },
              "id": {
                "type": "Consommation",
                "required": true
              }
            }
            }
      responses:
        201:
          description: La consommation a été bien payé
  /evenement:
    post:
      body:
          application/json:
            schema: |
              {
              "type": "object",
              "$schema": "http://json-schema.org/draft-03/schema",
              "id": "http://jsonschema.net",
              "required": true,
              "properties": {
                "participant": {
                  "type": "Personne",
                  "required": true
                },
                "id": {
                  "type": "Evenement",
                  "required": true
                }
              }
              }
      responses:
        201:
          description: L'evenement a bien été payé
    /credit:
      post:
        description: Permet de recharger ou debiter un compte
        body:
            application/json:
              schema: |
                  {
                  "type": "object",
                  "$schema": "http://json-schema.org/draft-03/schema",
                  "id": "http://jsonschema.net",
                  "required": true,
                  "properties": {
                    "participant": {
                      "type": "Personne",
                      "required": true
                    },
                    "prix": {
                      "type": "number",
                      "required": true
                    }
                  }
                  }
        responses:
          201:
            description: La personne a bien été crédité
  /{idPersonne}:
    uriParameters:
      idPersonne:
        type: integer
        required: true
        description: id de la personne dont on veut regarder les transactions
        minimum: 0
    get:
      description: Permet de recuperer la liste des transaction d'une personne
      responses:
        200:
          description: On recupere la liste des transactions
          body:
            application/json:
              example: |
                [
                  {
                    "participant": 1,
                    "acteur": 18,
                    "id": 42,
                    "type": true,
                    "date": "2003-12-01",
                    "prix": 25.23
                  },
                  {
                    "participant": 1,
                    "acteur": 12,
                    "id": 43,
                    "type": true,
                    "date": "2003-12-01",
                    "prix": -25.23
                  }
                ]
  /acteur/{idPersonne}:
    uriParameters:
      idPersonne:
        type: integer
        required: true
        description: id de la personne dont on veut regarder les transactions
        minimum: 0
    get:
      description: Permet de recuperer la liste des transaction d'une personne
      responses:
        200:
          description: On recupere la liste des transactions
          body:
            application/json:
              example: |
                [
                  {
                    "participant": 1,
                    "acteur": 18,
                    "idTransaction": 42,
                    "type": true,
                    "date": "2003-12-01",
                    "prix": 25.23
                  },
                  {
                    "participant": 1,
                    "acteur": 12,
                    "idTransaction": 43,
                    "type": true,
                    "date": "2003-12-01",
                    "prix": -25.23
                  }
                ]