623 lines
15 KiB
YAML
623 lines
15 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
title: ClydeAPI
|
|
description:
|
|
This is the Clyde's api documentation. <br/>
|
|
Each endpoints are organised by endpoints **AND** by extensions making it easier to navigate.
|
|
version: 0.0.1
|
|
|
|
servers:
|
|
- url: https://clyde.herisson.ovh/api
|
|
description: default api point for clyde's service
|
|
|
|
paths:
|
|
/ping:
|
|
get:
|
|
summary: Check the API status
|
|
responses:
|
|
default:
|
|
description: pong
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
example: pong
|
|
/users:
|
|
get:
|
|
summary: list all users
|
|
tags:
|
|
- General
|
|
- SI
|
|
security:
|
|
- bearer: []
|
|
parameters:
|
|
- in: query
|
|
name: type
|
|
required: false
|
|
schema:
|
|
type: string
|
|
enum: [teacher, student, secretary]
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/User"
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
|
|
/user:
|
|
get:
|
|
summary: get informations about yourself
|
|
tags:
|
|
- General
|
|
- Users
|
|
security:
|
|
- bearer: []
|
|
responses:
|
|
'200':
|
|
description: Ok
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/User"
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
post:
|
|
summary: Create user
|
|
tags:
|
|
- General
|
|
- Users
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
LastName:
|
|
type: string
|
|
FirstName:
|
|
type: string
|
|
Email:
|
|
type: string
|
|
Address:
|
|
$ref: "#/components/schemas/Address"
|
|
BirthDate:
|
|
type: string
|
|
description: Follow the iso 8601 ("YYYY-MM-DD")
|
|
example:
|
|
{
|
|
"LastName": "Doe" ,
|
|
"FirstName": "John",
|
|
"Email": "John.Doe@example.com",
|
|
"Address": {
|
|
"Address": "Rue de Tournais 42",
|
|
"Country": "BE"},
|
|
"BirthDate": "1941-02-22",
|
|
}
|
|
responses:
|
|
'201':
|
|
description: User created
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
patch:
|
|
summary: Change informations about yourself
|
|
tags:
|
|
- General
|
|
- Users
|
|
security:
|
|
- bearer: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
responses:
|
|
'201':
|
|
description: Successfully changed.
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
/user/{mat}:
|
|
parameters:
|
|
- name: mat
|
|
in: path
|
|
description: Matricule of the user (unique id)
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
get:
|
|
summary: Get user's informations
|
|
tags:
|
|
- General
|
|
- Admin
|
|
responses:
|
|
'200':
|
|
description: User found
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/User"
|
|
patch:
|
|
summary: Alter user's informations
|
|
tags:
|
|
- General
|
|
- Admin
|
|
- Secretariat
|
|
security:
|
|
- bearer: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
responses:
|
|
'201':
|
|
description: Successfully changed
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
/course:
|
|
post:
|
|
summary: Create new course
|
|
tags:
|
|
- General
|
|
- Courses
|
|
- Secretariat
|
|
security:
|
|
- bearer: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
courses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
responses:
|
|
'201':
|
|
description: course created
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
/courses/{id}:
|
|
get:
|
|
summary: see courses informations
|
|
tags:
|
|
- General
|
|
- Courses
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Course'
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
delete:
|
|
summary: delete a course
|
|
tags:
|
|
- General
|
|
- Courses
|
|
- Secretariat
|
|
security:
|
|
- bearer: []
|
|
responses:
|
|
'201':
|
|
description: Success
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
patch:
|
|
summary: Change course options
|
|
tags:
|
|
- General
|
|
- Secretariat
|
|
- Courses
|
|
security:
|
|
- bearer: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
credits:
|
|
type: integer
|
|
faculty:
|
|
type: string
|
|
teachers:
|
|
$ref: '#/components/schemas/User'
|
|
assistants:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/User'
|
|
example:
|
|
{
|
|
"name": "Math pour l'info",
|
|
"credits": 11,
|
|
"faculty": "science",
|
|
"Teacher": ,
|
|
"Assistants": [ ]
|
|
}
|
|
responses:
|
|
'201':
|
|
description: Course modified
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
|
|
/cursus:
|
|
post:
|
|
summary: Create a cursus
|
|
tags:
|
|
- General
|
|
- cursus
|
|
security:
|
|
- bearer: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
courses:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: id of courses
|
|
example:
|
|
{
|
|
"name": "Bac1",
|
|
[]
|
|
}
|
|
responses:
|
|
'201':
|
|
description: Cursus created
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
/cursus/{id}:
|
|
get:
|
|
summary: See Cursus's informations
|
|
tags:
|
|
- General
|
|
- cursus
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Cursus'
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
delete:
|
|
summary: Delete cursus
|
|
tags:
|
|
- General
|
|
- cursus
|
|
security:
|
|
- bearer: []
|
|
responses:
|
|
'201':
|
|
description: Success
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
patch:
|
|
summary: Modify cursus
|
|
tags:
|
|
- General
|
|
- cursus
|
|
security:
|
|
- bearer: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/x-www-form-urlencoded:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
credits:
|
|
type: integer
|
|
faculty:
|
|
type: string
|
|
teachers:
|
|
$ref: '#/components/schemas/User'
|
|
assistants:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/User'
|
|
example:
|
|
{
|
|
"name": "Math pour l'info",
|
|
"credits": 11,
|
|
"faculty": "science",
|
|
"Teacher": ,
|
|
"Assistants": [ ]
|
|
}
|
|
responses:
|
|
'201':
|
|
description: Cursus modified
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Extension publication scientifique
|
|
|
|
/article:
|
|
post:
|
|
summary: create an article
|
|
tags:
|
|
- Researcher
|
|
security:
|
|
- bearer : []
|
|
responses:
|
|
"201" :
|
|
description: OK
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
requestBody:
|
|
required : true
|
|
content:
|
|
application/pdf:
|
|
schema:
|
|
type: string
|
|
format : binary
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
acces:
|
|
type: string
|
|
summary:
|
|
type: string
|
|
language:
|
|
type: string
|
|
title:
|
|
type: string
|
|
date:
|
|
type: string
|
|
description: Follow the iso 8601 ("YYYY-MM-DD")
|
|
views:
|
|
type: integer #TODO check comment envoyer fichier + json
|
|
/article/{id}:
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
get:
|
|
summary: get a certain article
|
|
tags:
|
|
- Users
|
|
security:
|
|
- bearer: []
|
|
responses:
|
|
"201":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Article'
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
|
|
patch:
|
|
summary: modify an article
|
|
tags:
|
|
- Researcher
|
|
security:
|
|
- bearer : []
|
|
responses:
|
|
"201":
|
|
description: article modifié
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
requestBody:
|
|
required : true
|
|
content:
|
|
application/pdf:
|
|
schema:
|
|
type: string
|
|
format : binary
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
acces:
|
|
type: string
|
|
summary:
|
|
type: string
|
|
language:
|
|
type: string
|
|
title:
|
|
type: string
|
|
date:
|
|
type: string
|
|
description: Follow the iso 8601 ("YYYY-MM-DD")
|
|
views:
|
|
type: integer
|
|
|
|
delete:
|
|
summary: delete own article
|
|
tags:
|
|
- Researcher
|
|
security:
|
|
- bearer: []
|
|
responses:
|
|
'201':
|
|
description: OK
|
|
'401':
|
|
$ref: '#/components/responses/UnauthorizedError'
|
|
|
|
|
|
|
|
|
|
components:
|
|
securitySchemes:
|
|
bearer:
|
|
type: http
|
|
scheme: bearer
|
|
schemas:
|
|
User:
|
|
type: object
|
|
properties:
|
|
regNo:
|
|
type: integer
|
|
photo:
|
|
type: object
|
|
lastName:
|
|
type: string
|
|
firstName:
|
|
type: string
|
|
email:
|
|
type: string
|
|
address:
|
|
$ref: "#/components/schemas/Address"
|
|
birthDate:
|
|
type: string
|
|
description: Follow the iso 8601 ("YYYY-MM-DD")
|
|
example:
|
|
{
|
|
"regNo": 42,
|
|
"lastName": "Doe" ,
|
|
"firstName": "John",
|
|
"email": "John.Doe@example.com",
|
|
"address": {
|
|
"address": "Rue de Tournais 42",
|
|
"country": "BE"},
|
|
"birthDate": "1941-02-22",
|
|
"staffMember": true,
|
|
}
|
|
Address:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
country:
|
|
type: string
|
|
description: Follow the ISO-3166-1 alpha-2 standard.
|
|
example:
|
|
{
|
|
"address": "Rue de Tournais 42",
|
|
"country": "BE"
|
|
}
|
|
Course:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
credits:
|
|
type: integer
|
|
faculty:
|
|
type: string
|
|
teachers:
|
|
type: integer
|
|
description: user's id
|
|
assistants:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: user's id
|
|
example:
|
|
{
|
|
"id": 42,
|
|
"name": "Math pour l'info",
|
|
"credits": 11,
|
|
"faculty": "science",
|
|
"Teacher": 42,
|
|
"Assistants": [ ]
|
|
}
|
|
Cursus:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
courses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
{
|
|
"id": 42,
|
|
"courses": ['Math', 'Info']
|
|
}
|
|
|
|
Article:
|
|
type: object
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
acces :
|
|
type : string
|
|
pdf :
|
|
type : string
|
|
description : file location
|
|
summary:
|
|
type : string
|
|
language:
|
|
type : string
|
|
title :
|
|
type : string
|
|
date:
|
|
type : string
|
|
views :
|
|
type : integer
|
|
authors:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/User'
|
|
description: first user is the author, the remaining users are co-authors
|
|
example:
|
|
{
|
|
"articleId": 42,
|
|
"acces": "private",
|
|
"pdf": "/articles/42",
|
|
"summary": "looks in details about graph's second theorem",
|
|
"language": "english",
|
|
"title": "graph's second theorem study",
|
|
"date":"2023-02-01",
|
|
"views": 420,
|
|
"authors" : []
|
|
}
|
|
|
|
|
|
|
|
responses:
|
|
UnauthorizedError:
|
|
description: Unauthorized access or missing bearer
|