docs: added examples and changed some weird character
All checks were successful
CI / build (push) Successful in 11s
All checks were successful
CI / build (push) Successful in 11s
This commit is contained in:
parent
b355463dd9
commit
067eeb9494
@ -24,10 +24,13 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
email:
|
email:
|
||||||
type: string
|
type: string
|
||||||
scondaryEmail:
|
example: "example@exmaple.com"
|
||||||
|
secondaryEmail:
|
||||||
type: string
|
type: string
|
||||||
|
example: "example@exmaple.com"
|
||||||
tel:
|
tel:
|
||||||
type: string
|
type: string
|
||||||
|
example: "0612345678"
|
||||||
user-entrepreneur:
|
user-entrepreneur:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -38,10 +41,13 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
ecole:
|
ecole:
|
||||||
type: string
|
type: string
|
||||||
|
example: "enseirb"
|
||||||
filiere:
|
filiere:
|
||||||
type: string
|
type: string
|
||||||
|
example: "info"
|
||||||
status:
|
status:
|
||||||
type: string
|
type: boolean
|
||||||
|
example: false
|
||||||
user-admin:
|
user-admin:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -76,7 +82,7 @@ paths:
|
|||||||
- MyINPulse:
|
- MyINPulse:
|
||||||
- MyINPulse-admin
|
- MyINPulse-admin
|
||||||
description:
|
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..)
|
(project name, entrepreneur names, etc..)
|
||||||
of the projects an admin is watching over.
|
of the projects an admin is watching over.
|
||||||
responses:
|
responses:
|
||||||
@ -283,7 +289,7 @@ paths:
|
|||||||
- MyINPulse:
|
- MyINPulse:
|
||||||
- MyINPulse-admin
|
- MyINPulse-admin
|
||||||
description:
|
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,
|
necessary information for the view (project name,
|
||||||
entrepreneur names, etc..) of all pending projects.
|
entrepreneur names, etc..) of all pending projects.
|
||||||
responses:
|
responses:
|
||||||
@ -345,7 +351,7 @@ paths:
|
|||||||
"401":
|
"401":
|
||||||
description: Authorization information is missing or invalid
|
description: Authorization information is missing or invalid
|
||||||
|
|
||||||
/shared/projects/lcsection/{projectId}:
|
/shared/projects/lcsection/{projectId}/{title}/{date}:
|
||||||
get:
|
get:
|
||||||
summary: Retourne la liste de sections de LC avec un titre donné
|
summary: Retourne la liste de sections de LC avec un titre donné
|
||||||
tags:
|
tags:
|
||||||
@ -361,23 +367,26 @@ paths:
|
|||||||
date parameter is passed)
|
date parameter is passed)
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
required: true
|
||||||
name: projectId
|
name: projectId
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
|
- in: path
|
||||||
required: true
|
required: true
|
||||||
requestBody:
|
description: this number can be 1, 2,...,8. It is associated with the title of the lcsection
|
||||||
required: true
|
name: title
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
schema:
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
title:
|
|
||||||
type: integer
|
type: integer
|
||||||
description: the number associated with the title of the lcsection
|
enum: [1, 2, 3, 4, 5, 6, 7, 8]
|
||||||
date:
|
|
||||||
|
- 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
|
type: string
|
||||||
description: the date corresponding to the wanted version of lc section
|
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
@ -549,6 +558,7 @@ paths:
|
|||||||
- MyINPulse-entrepreneur
|
- MyINPulse-entrepreneur
|
||||||
- MyINPulse-admin
|
- MyINPulse-admin
|
||||||
requestBody:
|
requestBody:
|
||||||
|
description: \"participants\" property is an array containing userids of the participants in the appointement
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
@ -566,6 +576,7 @@ paths:
|
|||||||
applicantId:
|
applicantId:
|
||||||
type: integer
|
type: integer
|
||||||
participants:
|
participants:
|
||||||
|
#/* */
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: integer
|
type: integer
|
||||||
@ -630,7 +641,7 @@ paths:
|
|||||||
post:
|
post:
|
||||||
summary: ajouter une sections au LC
|
summary: ajouter une sections au LC
|
||||||
description:
|
description:
|
||||||
Adds input data to the user’s LC
|
Adds input data to the user's LC
|
||||||
with a specified title.
|
with a specified title.
|
||||||
tags:
|
tags:
|
||||||
- Entrepreneurs API
|
- Entrepreneurs API
|
||||||
|
Loading…
x
Reference in New Issue
Block a user