Coder Social home page Coder Social logo

bof-api's People

Contributors

mackwic avatar simonrenoult avatar

Watchers

 avatar  avatar  avatar  avatar

bof-api's Issues

(TODO) ETQ Consommateur de l'API JV une documentation de l'API

Critères d'acceptation:

  • GET / retourne les routes tel que dans l'exemple 1
  • (TODO) il y a un endpoint qui montre une doc sympa ? (APi doc ?)

Exemple 1:

> HTTP GET /

< 200 OK
{
   "name": "",
   "version": "",
   (...)
   "routes": {
      "/": {
        "GET": "Liste les routes et la version de l'API"
      },
   }
}

ETQ Consommateur JV que GET /bofs/sessions/2018-03-15/speakers retourne la liste des speakers de la session

Critères d'acceptance:

  • GET /bofs/sessions/2018-03-15/speakers existe et retourne un JSON tel que dans l'exemple au dessus
  • Les mails sont exactement extraits des colonnes F et L de la spreadsheet bofs (http://octoconf.octo.com)
  • Les mails sont séparés par une virgule dans la spreadsheet, l'api doit les séparer selon l'Exemple 2
  • Les données peuvent être invalides, l'API doit les valider et filtrer les résultats invalides selon l'Exemple 3

Exemple 1:

> HTTP GET /bofs/sessions/2018-03-15/speakers

< 200 OK
[
  "[email protected]", "[email protected]", "[email protected]", ...
]

Exemple 2:

Cellule Valeur parsée Commentaire
[email protected] [ "[email protected]" ]
[email protected], [email protected] [ "[email protected]", "[email protected]" ] Séparé par des virgules
\t [email protected], [email protected] [ "[email protected]", "[email protected]" ] Trimmer les espaces avant + après (voir le code de la page)
[email protected], ,,[email protected], [ "[email protected]", "[email protected]" ] Ignorer les items vides

Exemple 3:

Cellule Valeur parsée Commentaire
bes [] Un trigramme n'est pas un email valide
bes, [email protected] [ "[email protected]" ] On ignore le trigramme en début de ligne mais on garde l mail valide

ETQ Consommateur JV GET /bofs/sessions/2018-03-15 qui me retourne la liste des bofs à cette date

Exemple:

> HTTP GET /bofs/sessions/2018-03-15

< 200 OK
[
  { 
    track: 1,
    start: "14:00",
    end: "14:30",
    private: false,
    speakersMails: [ "[email protected]", "[email protected]" ],
    imageURL: "http://...",
    description: "une longue description...."
  }
]

Critère d'acceptance:

  • GET /bofs/sessions/:date retourne un objet comme dans l'exemple au dessus
  • Les sessions sont prises sur les 2 tracks (colonnes B-F et H-L de la spreadsheet)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.