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,169 +368,12 @@ paths:
$ref: '#/components/responses/UnauthorizedError' $ref: '#/components/responses/UnauthorizedError'
/RegRequests:
get :
summary : Get an array of every register requests
tags :
- RegisterRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/RegRequests'
/Requests/{type}:
/RegRequest/{id}:
get :
summary : Get all the data composing a register request
tags :
- RegisterRequests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
type : object
properties:
$ref : '#/components/schemas/RegRequest'
parameters:
- name: id
in: path
description: id of a regRequest
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: get:
summary : get the data of a single reregistration request summary: Give an array of every requests of the specified type
tags : tags :
- ReregisterRequests - Requests
- Ext (Student Registration)
responses :
'200':
description : OK
content :
application/json :
schema :
$ref : '#/components/schemas/ReRegRequest'
patch:
summary: Change the state of a reregister request
tags:
- ReregisterRequests
- 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'
/SSRequest:
get :
summary : Get an array of every scholarship requests
tags :
- ScholarshipRequests
- Ext (Student Registration) - Ext (Student Registration)
responses : responses :
'200': '200':
@ -540,50 +383,39 @@ paths:
schema : schema :
type : array type : array
items : items :
$ref : '#/components/schemas/SSRequest' oneOf:
post : - type : object
summary: Add a new scholarship request properties:
tags : id :
- ScholarshipRequests type : integer
- Ext (Student Registration) Firstname :
security: type : string
- bearer: [] Name :
requestBody: type : string
required: true Date :
content: type : string
application/x-www-form-urlencoded: description : Follow the iso 8601 ("YYYY-MM-DD")
schema: State :
$ref: '#/components/schemas/SSRequest' type : string
responses: - $ref : '#/components/schemas/RRRequest'
'201': - $ref : '#/components/schemas/SSRequest'
description: New scholarship request created - $ref : '#/components/schemas/UnRegRequest'
'401': - $ref : '#/components/schemas/ExempRequest'
$ref: '#/components/responses/UnauthorizedError' discriminator:
propertyName : type
/SSRequest/{id}:
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 scholarshiprequest description: type of the request
required: true required: true
schema: schema:
type: integer type: integer
get:
summary : get the data of a single scholarship request post :
summary: create a request
tags : tags :
- ScholarshipRequests - Requests
- 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) - Ext (Student Registration)
security: security:
- bearer: [] - bearer: []
@ -592,22 +424,40 @@ paths:
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: New request created
'401': '401':
$ref: '#/components/responses/UnauthorizedError' $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:
type: integer
- name : id
in : path
description: id of the selected Request
required : true
schema :
type : integer
/UnRegRequest:
get : get :
summary : Get an array of every unregister requests summary : Get all the data composing a request
tags : tags :
- UnregisterRequests - Requests
- Ext (Student Registration) - Ext (Student Registration)
responses : responses :
'200': '200':
@ -615,52 +465,19 @@ paths:
content : content :
application/json : application/json :
schema : schema :
type : array oneOf:
items : - $ref : '#/components/schemas/RRRequest'
$ref : '#/components/schemas/UnRegRequest' - $ref : '#/components/schemas/SSRequest'
post : - $ref : '#/components/schemas/UnRegRequest'
summary: Add a new unregister request - $ref : '#/components/schemas/ExempRequest'
tags : - $ref : '#/components/schemas/RegRequest'
- UnregisterRequests discriminator:
- Ext (Student Registration) propertyName : type
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: patch:
summary: Change the state of a unregister request summary: Change the state of request
tags: tags:
- UnregisterRequests - Requests
- Ext (Student Registration) - Ext (Student Registration)
security: security:
- bearer: [] - bearer: []
@ -668,94 +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'
/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 :