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

@ -368,11 +368,12 @@ paths:
$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,60 +383,39 @@ 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 :
tags : type : string
- RegisterRequests Name :
- Ext (Student Registration) type : string
responses : Date :
'200': type : string
description : OK description : Follow the iso 8601 ("YYYY-MM-DD")
content : State :
application/json : type : string
schema : - $ref : '#/components/schemas/RRRequest'
type : object - $ref : '#/components/schemas/SSRequest'
properties: - $ref : '#/components/schemas/UnRegRequest'
$ref : '#/components/schemas/RegRequest' - $ref : '#/components/schemas/ExempRequest'
discriminator:
propertyName : type
parameters: parameters:
- name: id - name: type
in: path 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: id of a regRequest description: type of the request
required: true required: true
schema: schema:
type: integer 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 : post :
summary: Add a new register request summary: create a request
tags : tags :
- RegisterRequests - Requests
- Ext (Student Registration) - Ext (Student Registration)
security: security:
- bearer: [] - bearer: []
@ -444,71 +424,60 @@ paths:
content: content:
application/x-www-form-urlencoded: application/x-www-form-urlencoded:
schema: schema:
$ref: '#/components/schemas/RegRequest' oneOf:
- $ref : '#/components/schemas/RRRequest'
- $ref : '#/components/schemas/SSRequest'
- $ref : '#/components/schemas/UnRegRequest'
- $ref : '#/components/schemas/ExempRequest'
- $ref : '#/components/schemas/RegRequest'
discriminator:
propertyName : type
responses: responses:
'201': '201':
description: New student created description: New request created
'401': '401':
$ref: '#/components/responses/UnauthorizedError' $ref: '#/components/responses/UnauthorizedError'
/ReRegRequest: /Requests/{type}{id}:
tonitch marked this conversation as resolved
Review

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

Il manque un / `/Requests/{type}/{id}`
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: parameters:
- name: id - name: type
in: path in: path
description: id of a reregistrationrequest description: type of the request
required: true required: true
schema: schema:
type: integer type: integer
get:
summary : get the data of a single reregistration request - name : id
in : path
description: id of the selected Request
required : true
schema :
type : integer
get :
summary : Get all the data composing a request
tags : tags :
- ReregisterRequests - Requests
- Ext (Student Registration) - Ext (Student Registration)
responses : responses :
'200': '200':
description : OK description : OK
content : content :
application/json : application/json :
schema : schema :
$ref : '#/components/schemas/ReRegRequest' oneOf:
- $ref : '#/components/schemas/RRRequest'
- $ref : '#/components/schemas/SSRequest'
- $ref : '#/components/schemas/UnRegRequest'
- $ref : '#/components/schemas/ExempRequest'
- $ref : '#/components/schemas/RegRequest'
discriminator:
propertyName : type
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,86 +485,15 @@ paths:
required: true required: true
content: content:
application/x-www-form-urlencoded: application/x-www-form-urlencoded:
schema:
type: object
properties:
State:
type: string
responses:
'201':
description: State modified
'401':
$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 : schema :
type : array oneOf:
items : - $ref : '#/components/schemas/RRRequest'
$ref : '#/components/schemas/SSRequest' - $ref : '#/components/schemas/SSRequest'
post : - $ref : '#/components/schemas/UnRegRequest'
summary: Add a new scholarship request - $ref : '#/components/schemas/ExempRequest'
tags : - $ref : '#/components/schemas/RegRequest'
- ScholarshipRequests discriminator:
- Ext (Student Registration) propertyName : type
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: responses:
'201': '201':
description: State modified description: State modified
@ -603,159 +501,6 @@ paths:
$ref: '#/components/responses/UnauthorizedError' $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 :