diff --git a/Documentation/openapi/main.yaml b/Documentation/openapi/main.yaml index 00dc3d4..263e9ab 100644 --- a/Documentation/openapi/main.yaml +++ b/Documentation/openapi/main.yaml @@ -24,10 +24,13 @@ components: type: string email: type: string - scondaryEmail: + example: "example@exmaple.com" + secondaryEmail: type: string + example: "example@exmaple.com" tel: type: string + example: "0612345678" user-entrepreneur: type: object properties: @@ -36,12 +39,15 @@ components: entrepreneur: type: object properties: - ecole: + ecole: type: string + example: "enseirb" filiere: type: string + example: "info" status: - type: string + type: boolean + example: false user-admin: type: object properties: @@ -76,7 +82,7 @@ paths: - MyINPulse: - MyINPulse-admin description: - JSON array of who’s elements are objects containing necessary information for the view + JSON array of who's elements are objects containing necessary information for the view (project name, entrepreneur names, etc..) of the projects an admin is watching over. responses: @@ -283,7 +289,7 @@ paths: - MyINPulse: - MyINPulse-admin description: - JSON array of who’s elements are objects containing + JSON array of who's elements are objects containing necessary information for the view (project name, entrepreneur names, etc..) of all pending projects. responses: @@ -345,7 +351,7 @@ paths: "401": description: Authorization information is missing or invalid - /shared/projects/lcsection/{projectId}: + /shared/projects/lcsection/{projectId}/{title}/{date}: get: summary: Retourne la liste de sections de LC avec un titre donné tags: @@ -361,23 +367,26 @@ paths: date parameter is passed) parameters: - in: path + required: true name: projectId schema: type: integer + - in: path required: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: integer - description: the number associated with the title of the lcsection - date: - type: string - description: the date corresponding to the wanted version of lc section + description: this number can be 1, 2,...,8. It is associated with the title of the lcsection + name: title + schema: + type: integer + enum: [1, 2, 3, 4, 5, 6, 7, 8] + + - in: path + required: true + name: date + description: the date corresponding to the wanted version of lc section. "Nan" for the latest version + example: "NaN" + schema: + type: string + responses: "200": description: OK @@ -549,6 +558,7 @@ paths: - MyINPulse-entrepreneur - MyINPulse-admin requestBody: + description: \"participants\" property is an array containing userids of the participants in the appointement required: true content: application/json: @@ -566,10 +576,11 @@ paths: applicantId: type: integer participants: + #/* */ type: array items: type: integer - + responses: "200": description: OK @@ -630,7 +641,7 @@ paths: post: summary: ajouter une sections au LC description: - Adds input data to the user’s LC + Adds input data to the user's LC with a specified title. tags: - Entrepreneurs API