salutcesmoileo #4

Merged
tonitch merged 10 commits from salutcesmoileo into master 2023-12-14 14:37:27 +01:00
Showing only changes of commit aacf1eef6c - Show all commits

View File

@ -367,12 +367,13 @@ paths:
'401': '401':
$ref: '#/components/responses/UnauthorizedError' $ref: '#/components/responses/UnauthorizedError'
/RegRequests:
get : /Requests/{type}:
summary : Get an array of every register requests get:
summary: Give an array of every requests of the specified type
tags : tags :
- RegisterRequests - Requests
- Ext (Student Registration) - Ext (Student Registration)
responses : responses :
'200': '200':
@ -382,14 +383,81 @@ paths:
schema : schema :
type : array type : array
items : items :
$ref : '#/components/schemas/RegRequests' oneOf:
- type : object
properties:
/RegRequest/{id}: id :
get : type : integer
summary : Get all the data composing a register request Firstname :
type : string
Name :
tonitch marked this conversation as resolved Outdated

PAS BIEN VAIS TE FRAPPER AVEC MA GROSSSE BATTE

PAS BIEN VAIS TE FRAPPER AVEC MA GROSSSE BATTE
type : string
Date :
type : string
description : Follow the iso 8601 ("YYYY-MM-DD")
State :
type : string
- $ref : '#/components/schemas/RRRequest'
- $ref : '#/components/schemas/SSRequest'
- $ref : '#/components/schemas/UnRegRequest'
- $ref : '#/components/schemas/ExempRequest'
discriminator:
propertyName : type
parameters:
- name: type
in: path
Review

je ne sais pas si c'est l'intention, mais tu n'as pas la possibilité de faire un fetch de toutes les requests.

le plus simple est de changer l'endpoint à /Requests
et le paramètre tu peux le mettre à in: query. en required: false

je ne sais pas si c'est l'intention, mais tu n'as pas la possibilité de faire un fetch de toutes les requests. le plus simple est de changer l'endpoint à `/Requests` et le paramètre tu peux le mettre à `in: query`. en `required: false`
description: type of the request
required: true
schema:
type: integer

tu peux ajouter la ligne
enum: blop1, blop2, blop3, ...
en dessous et au même niveau que type pour spécifier les différent paramètres disponible.

tu peux ajouter la ligne `enum: blop1, blop2, blop3, ...` en dessous et au même niveau que type pour spécifier les différent paramètres disponible.
post :

si tu appliques les précédents commentaire tu as soit le choix de laisser le post dans /Requests/{type} soit de le mettre avec /Requests et dans ce cas il suffit de mettre le type en paramètre dans requestBody ou dans query (je pense que requestBody serait mieux dans le cas présent)

si tu appliques les précédents commentaire tu as soit le choix de laisser le post dans `/Requests/{type}` soit de le mettre avec `/Requests` et dans ce cas il suffit de mettre le type en paramètre dans `requestBody` ou dans `query` (je pense que requestBody serait mieux dans le cas présent)
summary: create a request
tonitch marked this conversation as resolved Outdated

PAS studentRegistrattion

PAS studentRegistrattion
tags : tags :
- RegisterRequests - Requests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
oneOf:
tonitch marked this conversation as resolved Outdated

pour le patch ça pose pas de problème mais pour le post tu ne peux pas demander d'envoyer un id car il n'y a pas encore d'id.

Une solution serait d'enlever l'id dans les schèma dans le bas du document et des les ajouter explicitement quand tu peux (GET, PATCH -> si id peut être modifié)

pour le patch ça pose pas de problème mais pour le post tu ne peux pas demander d'envoyer un id car il n'y a pas encore d'id. Une solution serait d'enlever l'id dans les schèma dans le bas du document et des les ajouter explicitement quand tu peux (GET, PATCH -> si id peut être modifié)
- $ref : '#/components/schemas/RRRequest'
- $ref : '#/components/schemas/SSRequest'
- $ref : '#/components/schemas/UnRegRequest'
- $ref : '#/components/schemas/ExempRequest'
- $ref : '#/components/schemas/RegRequest'
discriminator:
propertyName : type
responses:
'201':
description: New request created
'401':
$ref: '#/components/responses/UnauthorizedError'
/Requests/{type}{id}:
tonitch marked this conversation as resolved
Review

Il manque un /
/Requests/{type}/{id}

Il manque un / `/Requests/{type}/{id}`
parameters:
- name: type
in: path
description: type of the request
required: true
schema:
tonitch marked this conversation as resolved Outdated

Ici en utilisant le ref, l'id est présent. sauf que tu ne peux pas post avec un id vu qu'il est généré par le post.

Ici en utilisant le ref, l'id est présent. sauf que tu ne peux pas post avec un id vu qu'il est généré par le post.
type: integer
- name : id
tonitch marked this conversation as resolved Outdated

New Student created -> Register request created ?

New Student created -> Register request created ?
in : path
description: id of the selected Request
required : true
schema :
tonitch marked this conversation as resolved Outdated

Est-ce vraiment nécéssaire de faire des ré-ré register ? est-ce que ca ne serais pas une sous-classe de register avec peut être un bool pour dire si c'est la première fois ou non ?

Est-ce vraiment nécéssaire de faire des ré-ré register ? est-ce que ca ne serais pas une sous-classe de register avec peut être un bool pour dire si c'est la première fois ou non ?

Non, cela impliquerait une redondance d'informations. Quand un étudiant se réinscrit on a pas besoin de restocker son nom, son prénom, son adresse, ...
On les a déja avec le matricule.

Non, cela impliquerait une redondance d'informations. Quand un étudiant se réinscrit on a pas besoin de restocker son nom, son prénom, son adresse, ... On les a déja avec le matricule.

Le fait de metre des end-points n'a rien à voir avec le stockage d'information tho. ton end point peut être clair et concis tandis que ta base de données et ton backend s'occupent de chercher les infos ou tu veux. en clair tu ne dois pas suivre ce qui est fait dans class et db

Le fait de metre des end-points n'a rien à voir avec le stockage d'information tho. ton end point peut être clair et concis tandis que ta base de données et ton backend s'occupent de chercher les infos ou tu veux. en clair tu ne dois pas suivre ce qui est fait dans class et db
type : integer
get :
summary : Get all the data composing a request
tags :
- Requests
- Ext (Student Registration) - Ext (Student Registration)
responses : responses :
'200': '200':
@ -397,118 +465,19 @@ paths:
content : content :
application/json : application/json :
schema : schema :
type : object oneOf:
properties: - $ref : '#/components/schemas/RRRequest'
$ref : '#/components/schemas/RegRequest' - $ref : '#/components/schemas/SSRequest'
- $ref : '#/components/schemas/UnRegRequest'
parameters: - $ref : '#/components/schemas/ExempRequest'
- name: id - $ref : '#/components/schemas/RegRequest'
in: path discriminator:
description: id of a regRequest propertyName : type
required: true
schema:
type: integer
patch:
summary: Change the state of a register request
tags:
- RegisterRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
State:
type: string
responses:
'201':
description: State modified
'401':
$ref: '#/components/responses/UnauthorizedError'
/RegRequest:
post :
summary: Add a new register request
tags :
- RegisterRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/RegRequest'
responses:
'201':
description: New student created
'401':
$ref: '#/components/responses/UnauthorizedError'
/ReRegRequest:
get :
summary : Get an array of every reregister requests
tags :
- ReregisterRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/ReRegRequest'
post :
summary: Add a new ReRegister request
tags :
- ReregisterRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ReRegRequest'
responses:
'201':
description: New ReRegister request created
'401':
$ref: '#/components/responses/UnauthorizedError'
/ReRegRequest/{id}:
parameters:
- name: id
in: path
description: id of a reregistrationrequest
required: true
schema:
type: integer
get:
summary : get the data of a single reregistration request
tags :
- ReregisterRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
$ref : '#/components/schemas/ReRegRequest'
patch: patch:
summary: Change the state of a reregister request summary: Change the state of request
tags: tags:
- ReregisterRequests - Requests
- Ext (Student Registration) - Ext (Student Registration)
security: security:
- bearer: [] - bearer: []
@ -516,246 +485,22 @@ paths:
required: true required: true
content: content:
application/x-www-form-urlencoded: application/x-www-form-urlencoded:
schema: schema :
type: object oneOf:
properties: - $ref : '#/components/schemas/RRRequest'
State: - $ref : '#/components/schemas/SSRequest'
type: string - $ref : '#/components/schemas/UnRegRequest'
- $ref : '#/components/schemas/ExempRequest'
- $ref : '#/components/schemas/RegRequest'
discriminator:
propertyName : type
responses: responses:
'201': '201':
description: State modified description: State modified
'401': '401':
$ref: '#/components/responses/UnauthorizedError' $ref: '#/components/responses/UnauthorizedError'
/SSRequest:
get :
summary : Get an array of every scholarship requests
tags :
- ScholarshipRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/SSRequest'
post :
summary: Add a new scholarship request
tags :
- ScholarshipRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SSRequest'
responses:
'201':
description: New scholarship request created
'401':
$ref: '#/components/responses/UnauthorizedError'
/SSRequest/{id}:
parameters:
- name: id
in: path
description: id of a scholarshiprequest
required: true
schema:
type: integer
get:
summary : get the data of a single scholarship request
tags :
- ScholarshipRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
$ref : '#/components/schemas/SSRequest'
patch:
summary: Change the state of a scholarship request
tags:
- ScholarshipRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
State:
type: string
responses:
'201':
description: State modified
'401':
$ref: '#/components/responses/UnauthorizedError'
/UnRegRequest:
get :
summary : Get an array of every unregister requests
tags :
- UnregisterRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/UnRegRequest'
post :
summary: Add a new unregister request
tags :
- UnregisterRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UnRegRequest'
responses:
'201':
description: New unregister request created
'401':
$ref: '#/components/responses/UnauthorizedError'
/UnRegRequest{id}:
parameters:
- name: id
in: path
description: id of a unregistrationrequest
required: true
schema:
type: integer
get:
summary : get the data of a single unregistration request
tags :
- UnregisterRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
$ref : '#/components/schemas/UnRegRequest'
patch:
summary: Change the state of a unregister request
tags:
- UnregisterRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
State:
type: string
responses:
'201':
description: State modified
'401':
$ref: '#/components/responses/UnauthorizedError'
/ExempRequest:
get :
summary : Get an array of every exemptions requests
tags :
- ExemptionRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/ExempRequest'
post :
summary: Add a new exemption request
tags :
- ExemptionRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExempRequest'
responses:
'201':
description: New exemption request created
'401':
$ref: '#/components/responses/UnauthorizedError'
/ExempRequest/{id}:
parameters:
- name: id
in: path
description: id of a exemption request
required: true
schema:
type: integer
get:
summary : get the data of a single exemption request
tags :
- ExemptionRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
$ref : '#/components/schemas/ExempRequest'
patch:
summary: Change the state of a exemption request
tags:
- ExemptionRequests
- Ext (Student Registration)
security:
- bearer: []
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
State:
type: string
responses:
'201':
description: State modified
'401':
$ref: '#/components/responses/UnauthorizedError'
components: components:
securitySchemes: securitySchemes:
bearer: bearer:
@ -887,23 +632,8 @@ components:
State: State:
type : string type : string
RegRequests:
type : object
properties:
id :
type : integer
Firstname :
type : string
Name :
type : string
Date :
type : string
description : Follow the iso 8601 ("YYYY-MM-DD")
State :
type : string
RRRequest:
ReRegRequest:
type : object type : object
properties : properties :
id : id :