{"openapi":"3.0.0","info":{"version":"1.1.7","title":"5DriversAPI - find your matches","description":"API for 5Drivers platform <br> contains all operations on the match-finding process"},"tags":[{"name":"questionnaires","description":"All operations on a questionnaire of a driver"},{"name":"match list","description":"operations for the list of matches of a driver"}],"paths":{"/drivers/{driverID}/qeustionnaires":{"post":{"summary":"creates a questionnaire for the driver with given driverID","tags":["questionnaires"],"parameters":[{"$ref":"#/components/parameters/driverID"}],"responses":{"201":{"$ref":"#/components/responses/201Created"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/questionnaire"}}}}},"get":{"summary":"returns the questionnaire to analyse the characteristics of the driver","tags":["questionnaires"],"parameters":[{"$ref":"#/components/parameters/driverID"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/questionnaire"}}}},"404":{"$ref":"#/components/responses/404Error"}}},"delete":{"summary":"deletes questionnaire of driver","tags":["questionnaires"],"parameters":[{"$ref":"#/components/parameters/driverID"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/questionnaire"}}}},"404":{"$ref":"#/components/responses/404Error"}}},"put":{"summary":"updates an existing questionnaire of a driver with given driverID","tags":["questionnaires"],"parameters":[{"$ref":"#/components/parameters/driverID"}],"responses":{"200":{"description":"ok"},"404":{"$ref":"#/components/responses/404Error"}}}},"/driver/{driverID}/matchlist":{"post":{"summary":"creates the list of matches of a driver after analysis","tags":["match list"],"parameters":[{"$ref":"#/components/parameters/driverID"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/matchlist"}}}},"404":{"$ref":"#/components/responses/404Error"}}},"get":{"summary":"returns the list of matches of a driver after analysis","tags":["match list"],"parameters":[{"$ref":"#/components/parameters/driverID"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/matchlist"}}}},"404":{"$ref":"#/components/responses/404Error"}}}}},"components":{"schemas":{"driverID":{"type":"integer","description":"definition of the unique driverID","example":93834747},"matchlist":{"description":"array of driver IDs, <br>defines a list of drivers who match the analyzed driver","type":"array","items":{"$ref":"#/components/schemas/driverID"}},"questionnaire":{"type":"string","description":"list of questions and answers, <br> format \"question1\":\"answer1\";\"question2\":\"answer2\"...<br> answers are empty when first created","example":"How old are you?:27;Do you have animals?:yes;Do you smoke?:no"}},"parameters":{"driverID":{"name":"driverID","description":"ID of driver","in":"path","required":true,"schema":{"$ref":"#/components/schemas/driverID"}}},"responses":{"201Created":{"description":"created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"400Error":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"404Error":{"description":"Unknown ressource","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/Zeppelin-University/5Drivers_API/1.1.6"}]}