Skip to content

Commit

Permalink
prettier/linter
Browse files Browse the repository at this point in the history
  • Loading branch information
dodoLaprovence committed Sep 12, 2024
1 parent 4f242db commit b6f0e60
Show file tree
Hide file tree
Showing 4 changed files with 208 additions and 214 deletions.
2 changes: 1 addition & 1 deletion server/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ import { jsonify } from './middlewares/jsonify';
import { setVillage } from './middlewares/setVillage';
import { removeTrailingSlash } from './middlewares/trailingSlash';
import { filesRouter } from './routes/filesRouter';
import { swaggerSpec, swaggerUi } from './swagger';
import { connectToDatabase } from './utils/database';
import { logger } from './utils/logger';
import { getDefaultDirectives } from './utils/server';
import { swaggerSpec, swaggerUi } from './swagger';

const isDevENV = process.env.NODE_ENV !== 'production';
const frontendHandler = next({ dev: isDevENV });
Expand Down
10 changes: 5 additions & 5 deletions server/swagger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,28 @@
import swaggerJSDoc from 'swagger-jsdoc';
import swaggerUi from 'swagger-ui-express';

import { authenticationDocs } from './swagger/authentification';
import { activitiesDocs } from './swagger/activities';
import { analyticsDocs } from './swagger/analytics';
import { archivesDocs } from './swagger/archives';
import { audiosDocs } from './swagger/audios';
import { authenticationDocs } from './swagger/authentification';
import { classroomDocs } from './swagger/classroom';
import { mediathequeDocs } from './swagger/mediatheque';
import { statisticsDocs } from './swagger/statistics';
import { usersDocs } from './swagger/users';
import { villagesDocs } from './swagger/villages';
import { commentDocs } from './swagger/comment';
import { countriesDocs } from './swagger/countries';
import { currenciesDocs } from './swagger/currencies';
import { featureFlagDocs } from './swagger/featureFlag';
import { gamesDocs } from './swagger/games';
import { imagesDocs } from './swagger/images';
import { languagesDocs } from './swagger/languages';
import { mediathequeDocs } from './swagger/mediatheque';
import { pelicoPresentationDocs } from './swagger/pelicoPresentation';
import { statisticsDocs } from './swagger/statistics';
import { storyDocs } from './swagger/story';
import { studentsDocs } from './swagger/students';
import { teachersDocs } from './swagger/teachers';
import { teamCommentDocs } from './swagger/teamComment';
import { usersDocs } from './swagger/users';
import { villagesDocs } from './swagger/villages';
import { weatherDocs } from './swagger/weather';
import { xApiDocs } from './swagger/xApi';

Expand Down
194 changes: 94 additions & 100 deletions server/swagger/activities.ts
Original file line number Diff line number Diff line change
@@ -1,125 +1,119 @@
export const activitiesDocs = {
'/api/activities': {
get: {
summary: 'Récupère toutes les activités',
tags: ['Activities'],
parameters: [
{ in: 'query', name: 'limit', schema: { type: 'integer' }, description: 'Limite du nombre de résultats' },
{ in: 'query', name: 'page', schema: { type: 'integer' }, description: 'Page des résultats' },
{ in: 'query', name: 'villageId', schema: { type: 'integer' }, description: 'ID du village pour filtrer' },
{ in: 'query', name: 'countries', schema: { type: 'string' }, description: 'Pays pour filtrer' },
// Ajoutez tous les autres paramètres ici
],
responses: {
'200': {
description: 'Liste des activités récupérées',
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'object',
properties: {
id: { type: 'integer', description: "ID de l'activité" },
type: { type: 'integer', description: "Type de l'activité" },
// Ajoutez d'autres propriétés ici
},
},
},
},
},
},
'403': { description: 'Accès interdit' },
'500': { description: 'Erreur du serveur' },
},
},
post: {
summary: 'Crée une nouvelle activité',
tags: ['Activities'],
requestBody: {
required: true,
'/api/activities': {
get: {
summary: 'Récupère toutes les activités',
tags: ['Activities'],
parameters: [
{ in: 'query', name: 'limit', schema: { type: 'integer' }, description: 'Limite du nombre de résultats' },
{ in: 'query', name: 'page', schema: { type: 'integer' }, description: 'Page des résultats' },
{ in: 'query', name: 'villageId', schema: { type: 'integer' }, description: 'ID du village pour filtrer' },
{ in: 'query', name: 'countries', schema: { type: 'string' }, description: 'Pays pour filtrer' },
// Ajoutez tous les autres paramètres ici
],
responses: {
'200': {
description: 'Liste des activités récupérées',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
type: { type: 'integer', description: "Type de l'activité" },
subType: { type: 'integer', nullable: true, description: "Sous-type de l'activité" },
status: { type: 'integer', nullable: true, description: "Statut de l'activité" },
// Ajoutez d'autres champs ici
type: 'array',
items: {
type: 'object',
properties: {
id: { type: 'integer', description: "ID de l'activité" },
type: { type: 'integer', description: "Type de l'activité" },
// Ajoutez d'autres propriétés ici
},
},
required: ['type', 'data', 'content'],
},
},
},
},
responses: {
'201': { description: 'Activité créée avec succès' },
'400': { description: 'Données invalides fournies' },
'403': { description: 'Accès interdit' },
'500': { description: 'Erreur du serveur' },
},
'403': { description: 'Accès interdit' },
'500': { description: 'Erreur du serveur' },
},
},
'/api/activities/{id}': {
get: {
summary: 'Récupère une activité par ID',
tags: ['Activities'],
parameters: [
{ in: 'path', name: 'id', schema: { type: 'integer' }, required: true, description: "ID de l'activité" },
],
responses: {
'200': {
description: 'Activité récupérée avec succès',
content: {
'application/json': {
schema: { type: 'object' },
post: {
summary: 'Crée une nouvelle activité',
tags: ['Activities'],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
properties: {
type: { type: 'integer', description: "Type de l'activité" },
subType: { type: 'integer', nullable: true, description: "Sous-type de l'activité" },
status: { type: 'integer', nullable: true, description: "Statut de l'activité" },
// Ajoutez d'autres champs ici
},
required: ['type', 'data', 'content'],
},
},
'404': { description: 'Activité non trouvée' },
'500': { description: 'Erreur du serveur' },
},
},
put: {
summary: 'Met à jour une activité',
tags: ['Activities'],
parameters: [
{ in: 'path', name: 'id', schema: { type: 'integer' }, required: true, description: "ID de l'activité" },
],
requestBody: {
required: true,
responses: {
'201': { description: 'Activité créée avec succès' },
'400': { description: 'Données invalides fournies' },
'403': { description: 'Accès interdit' },
'500': { description: 'Erreur du serveur' },
},
},
},
'/api/activities/{id}': {
get: {
summary: 'Récupère une activité par ID',
tags: ['Activities'],
parameters: [{ in: 'path', name: 'id', schema: { type: 'integer' }, required: true, description: "ID de l'activité" }],
responses: {
'200': {
description: 'Activité récupérée avec succès',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
status: { type: 'integer', nullable: true, description: 'Statut de l\'activité' },
// Ajoutez d'autres propriétés ici
},
},
schema: { type: 'object' },
},
},
},
responses: {
'200': { description: 'Activité mise à jour avec succès' },
'400': { description: 'Données invalides fournies' },
'404': { description: 'Activité non trouvée' },
'500': { description: 'Erreur du serveur' },
},
'404': { description: 'Activité non trouvée' },
'500': { description: 'Erreur du serveur' },
},
delete: {
summary: 'Supprime une activité',
tags: ['Activities'],
parameters: [
{ in: 'path', name: 'id', schema: { type: 'integer' }, required: true, description: "ID de l'activité" },
],
responses: {
'204': { description: 'Activité supprimée avec succès' },
'403': { description: 'Accès interdit' },
'404': { description: 'Activité non trouvée' },
'500': { description: 'Erreur du serveur' },
},
put: {
summary: 'Met à jour une activité',
tags: ['Activities'],
parameters: [{ in: 'path', name: 'id', schema: { type: 'integer' }, required: true, description: "ID de l'activité" }],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
properties: {
status: { type: 'integer', nullable: true, description: "Statut de l'activité" },
// Ajoutez d'autres propriétés ici
},
},
},
},
},
responses: {
'200': { description: 'Activité mise à jour avec succès' },
'400': { description: 'Données invalides fournies' },
'404': { description: 'Activité non trouvée' },
'500': { description: 'Erreur du serveur' },
},
},
delete: {
summary: 'Supprime une activité',
tags: ['Activities'],
parameters: [{ in: 'path', name: 'id', schema: { type: 'integer' }, required: true, description: "ID de l'activité" }],
responses: {
'204': { description: 'Activité supprimée avec succès' },
'403': { description: 'Accès interdit' },
'404': { description: 'Activité non trouvée' },
'500': { description: 'Erreur du serveur' },
},
},
}
},
};
Loading

0 comments on commit b6f0e60

Please sign in to comment.