Merge branch '801-ui-fix-hamburger-menu-remove-breakpoint-and-closeop…

…en-on-click-in-storybook' of github.com:IT-Academy-BCN/ita-wiki into 801-ui-fix-hamburger-menu-remove-breakpoint-and-closeopen-on-click-in-storybook
IT-Academy-BCN · Jul 2, 2024 · afbe2a9 · afbe2a9
2 parents ac859ea + 5efdf9e
commit afbe2a9
Show file tree

Hide file tree

Showing 28 changed files with 57 additions and 5 deletions.
diff --git a/services/wiki/CHANGELOG.md b/services/wiki/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.18.1] - 2024-07-01
+
+### Added
+
+- Added `operationId` to all endpoints in the Swagger documentation generated by Zod.
+
 ## [0.18.0] - 2024-06-26
 
 ### Changed

diff --git a/services/wiki/openapi.yaml b/services/wiki/openapi.yaml
@@ -1,5 +1,5 @@
 info:
-  version: 0.17.0
+  version: 0.18.1
   title: IT Academy Wiki
   description: Our app implements a Wiki to be used as a knowledge base by the
     students of the Barcelona Activa's IT Academy
@@ -138,6 +138,7 @@ paths:
     post:
       tags:
         - auth
+      operationId: postLogin
       description: Takes a DNI and a password and returns a session cookie
       summary: Logs in a user
       requestBody:
@@ -203,6 +204,7 @@ paths:
     post:
       tags:
         - auth
+      operationId: postRegister
       description: Takes a DNI, a password, a name and an email an registers a user to
         the system
       summary: Registers a new user
@@ -274,6 +276,7 @@ paths:
     get:
       tags:
         - auth
+      operationId: getMe
       description: Returns information of a logged in user. Token recieved in the
         login necessary.
       summary: Get user information
@@ -344,6 +347,7 @@ paths:
     get:
       tags:
         - auth
+      operationId: getLogout
       description: Deletes cookie and logouts user
       summary: Logs out user
       responses:
@@ -353,6 +357,7 @@ paths:
     get:
       tags:
         - categories
+      operationId: listCategories
       description: Get all categories saved in the database
       summary: Get all categories
       responses:
@@ -380,6 +385,7 @@ paths:
     post:
       tags:
         - categories
+      operationId: postCategories
       description: Creates a new category. The requestor has to be logged in and with
         role ADMIN.
       summary: Creates a new category.
@@ -432,6 +438,7 @@ paths:
     patch:
       tags:
         - categories
+      operationId: patchCategories
       summary: Patch a category by its ID.
       description: Modifies an existing category. The requestor has to be logged in
         and with role ADMIN.
@@ -493,6 +500,7 @@ paths:
     get:
       tags:
         - topics
+      operationId: listTopics
       description: Returns a list of all topics. Filter by category id or category
         slug possible. If both filters are sent, will only search by category
         id.
@@ -545,6 +553,7 @@ paths:
     post:
       tags:
         - topics
+      operationId: postTopics
       description: Creates a new topic. The requestor has to be logged in and with
         role MENTOR or higher.
       summary: Creates a new topic.
@@ -598,6 +607,7 @@ paths:
     patch:
       tags:
         - topics
+      operationId: patchTopics
       description: Modifies an existing topic. The requestor has to be logged in and
         with role MENTOR or higher.
       summary: Patch a topic.
@@ -656,6 +666,7 @@ paths:
     get:
       tags:
         - resources
+      operationId: listFavoritesResources
       description: Retrieves the users favorite resources when logged in
       summary: Returns favorite resources by user and category
       parameters:
@@ -810,6 +821,7 @@ paths:
     get:
       tags:
         - resources
+      operationId: listResources
       description: Returns a collection of resources. Filters by resource type, topic
         name and category slug are optional. Resources that match all filters
         are fetched.
@@ -1014,6 +1026,7 @@ paths:
     post:
       tags:
         - resources
+      operationId: postResources
       description: Allows a logged in user to post a resource.
       summary: Post a resource
       security:
@@ -1066,6 +1079,7 @@ paths:
     patch:
       tags:
         - resources
+      operationId: patchResources
       description: Allows a logged in user to modify his resources.
       summary: Patch a resource
       security:
@@ -1112,6 +1126,7 @@ paths:
     post:
       tags:
         - seen
+      operationId: postUserSeenResourcesById
       description: Allows a logged in user to mark a resource as viewed.
       summary: Mark a resource as viewed
       security:
@@ -1140,6 +1155,7 @@ paths:
     get:
       tags:
         - resources
+      operationId: getResourcesById
       summary: Returns a resource by its ID
       description: Takes in a valid resource ID and returns the resource related to it.
       parameters:
@@ -1303,6 +1319,7 @@ paths:
     get:
       tags:
         - resources
+      operationId: listUserMeResources
       summary: Get resources by logged in user
       description: Returns all the posted resources by a logged in user. In addition,
         if categorySlug query provided, returns only the resources posted in
@@ -1465,6 +1482,7 @@ paths:
     get:
       tags:
         - vote
+      operationId: listVotes
       description: Retrieve a detailed vote count for a specified resource, including
         the number of upvotes, downvotes, and the overall vote balance.
       summary: Fetch detailed vote statistics for a resource.
@@ -1680,6 +1698,7 @@ paths:
     get:
       tags:
         - types
+      operationId: listResourceTypes
       description: Returns an array of all the resource types
       summary: Returns resource types
       responses:
@@ -1699,6 +1718,7 @@ paths:
     get:
       tags:
         - users
+      operationId: listUsers
       description: Returns information of all users. User must be ADMIN and logged in.
       summary: Get all users
       security:
@@ -1783,6 +1803,7 @@ paths:
     patch:
       tags:
         - users
+      operationId: patchUsersById
       description: Allows a logged in ADMIN user to modify another user.
       summary: Patch a user.
       security:
@@ -1879,6 +1900,7 @@ paths:
     put:
       tags:
         - favorites
+      operationId: putFavorites
       description: Allows a logged in users to add/remove favorite resources.
       summary: Put or delete a favorite resource by userId.
       security:
@@ -1922,6 +1944,7 @@ paths:
     get:
       tags:
         - itinerary
+      operationId: listItineraries
       description: Fetches all available itineraries
       summary: Get all itineraries
       responses:

diff --git a/services/wiki/package-lock.json b/services/wiki/package-lock.json
diff --git a/services/wiki/package.json b/services/wiki/package.json
@@ -1,7 +1,7 @@
 {
   "name": "service_wiki",
   "private": true,
-  "version": "0.18.0",
+  "version": "0.18.1",
   "prisma": {
     "seed": "tsx prisma/seed.ts"
   },

diff --git a/services/wiki/src/openapi/config.ts b/services/wiki/src/openapi/config.ts
@@ -5,7 +5,7 @@ export const openapiFilename = 'openapi.yaml'
 
 export const generatorConfig = {
   info: {
-    version: '0.18.0',
+    version: '0.18.1',
     title: 'IT Academy Wiki',
     description:
       "Our app implements a Wiki to be used as a knowledge base by the students of the Barcelona Activa's IT Academy",

diff --git a/services/wiki/src/openapi/routes/auth/login.ts b/services/wiki/src/openapi/routes/auth/login.ts
@@ -14,6 +14,7 @@ registry.registerPath({
   method: 'post',
   tags: ['auth'],
   path: `${pathRoot.v1.auth}/login`,
+  operationId: 'postLogin',
   description: 'Takes a DNI and a password and returns a session cookie',
   summary: 'Logs in a user',
   request: {

diff --git a/services/wiki/src/openapi/routes/auth/logout.ts b/services/wiki/src/openapi/routes/auth/logout.ts
@@ -4,6 +4,7 @@ import { registry } from '../../registry'
 registry.registerPath({
   method: 'get',
   tags: ['auth'],
+  operationId: 'getLogout',
   path: `${pathRoot.v1.auth}/logout`,
   description: 'Deletes cookie and logouts user',
   summary: 'Logs out user',

diff --git a/services/wiki/src/openapi/routes/auth/me.ts b/services/wiki/src/openapi/routes/auth/me.ts
@@ -14,6 +14,7 @@ registry.registerPath({
   method: 'get',
   tags: ['auth'],
   path: `${pathRoot.v1.auth}/me`,
+  operationId: 'getMe',
   description:
     'Returns information of a logged in user. Token recieved in the login necessary.',
   summary: 'Get user information',

diff --git a/services/wiki/src/openapi/routes/auth/register.ts b/services/wiki/src/openapi/routes/auth/register.ts
@@ -12,6 +12,7 @@ registry.registerPath({
   method: 'post',
   tags: ['auth'],
   path: `${pathRoot.v1.auth}/register`,
+  operationId: 'postRegister',
   description:
     'Takes a DNI, a password, a name and an email an registers a user to the system',
   summary: 'Registers a new user',

diff --git a/services/wiki/src/openapi/routes/categories/create.ts b/services/wiki/src/openapi/routes/categories/create.ts
@@ -10,6 +10,7 @@ registry.registerPath({
   method: 'post',
   tags: ['categories'],
   path: `${pathRoot.v1.categories}`,
+  operationId: 'postCategories',
   description:
     'Creates a new category. The requestor has to be logged in and with role ADMIN.',
   summary: 'Creates a new category.',

diff --git a/services/wiki/src/openapi/routes/categories/get.ts b/services/wiki/src/openapi/routes/categories/get.ts
@@ -6,6 +6,7 @@ registry.registerPath({
   method: 'get',
   tags: ['categories'],
   path: `${pathRoot.v1.categories}`,
+  operationId: 'listCategories',
   description: 'Get all categories saved in the database',
   summary: 'Get all categories',
   responses: {

diff --git a/services/wiki/src/openapi/routes/categories/patch.ts b/services/wiki/src/openapi/routes/categories/patch.ts
@@ -10,6 +10,7 @@ registry.registerPath({
   method: 'patch',
   tags: ['categories'],
   path: `${pathRoot.v1.categories}/id/{id}`,
+  operationId: 'patchCategories',
   summary: 'Patch a category by its ID.',
   description:
     'Modifies an existing category. The requestor has to be logged in and with role ADMIN.',

diff --git a/services/wiki/src/openapi/routes/favorites/put.ts b/services/wiki/src/openapi/routes/favorites/put.ts
@@ -13,6 +13,7 @@ registry.registerPath({
   method: 'put',
   tags: ['favorites'],
   path: `${pathRoot.v1.favorites}`,
+  operationId: 'putFavorites',
   description: 'Allows a logged in users to add/remove favorite resources.',
   summary: 'Put or delete a favorite resource by userId.',
   security: [{ [cookieAuth.name]: [] }],

diff --git a/services/wiki/src/openapi/routes/itinerary/get.ts b/services/wiki/src/openapi/routes/itinerary/get.ts
@@ -7,6 +7,7 @@ registry.registerPath({
   method: 'get',
   tags: ['itinerary'],
   path: `${pathRoot.v1.itinerary}`,
+  operationId: 'listItineraries',
   description: 'Fetches all available itineraries',
   summary: 'Get all itineraries',
   responses: {

diff --git a/services/wiki/src/openapi/routes/resources/create.ts b/services/wiki/src/openapi/routes/resources/create.ts
@@ -8,6 +8,7 @@ registry.registerPath({
   method: 'post',
   tags: ['resources'],
   path: `${pathRoot.v1.resources}`,
+  operationId: 'postResources',
   description: 'Allows a logged in user to post a resource.',
   summary: 'Post a resource',
   security: [{ [cookieAuth.name]: [] }],

diff --git a/services/wiki/src/openapi/routes/resources/favorites.ts b/services/wiki/src/openapi/routes/resources/favorites.ts
@@ -11,6 +11,7 @@ registry.registerPath({
   method: 'get',
   tags: ['resources'],
   path: `${pathRoot.v1.resources}/favorites`,
+  operationId: 'listFavoritesResources',
   description: 'Retrieves the users favorite resources when logged in',
   summary: 'Returns favorite resources by user and category',
   parameters: [

diff --git a/services/wiki/src/openapi/routes/resources/id.ts b/services/wiki/src/openapi/routes/resources/id.ts
@@ -12,6 +12,7 @@ registry.registerPath({
   method: 'get',
   tags: ['resources'],
   path: `${pathRoot.v1.resources}/{resourceId}`,
+  operationId: 'getResourcesById',
   summary: 'Returns a resource by its ID',
   description:
     'Takes in a valid resource ID and returns the resource related to it.',

diff --git a/services/wiki/src/openapi/routes/resources/list.ts b/services/wiki/src/openapi/routes/resources/list.ts
@@ -11,6 +11,7 @@ registry.registerPath({
   method: 'get',
   tags: ['resources'],
   path: `${pathRoot.v1.resources}`,
+  operationId: 'listResources',
   description:
     'Returns a collection of resources. Filters by resource type, topic name and category slug are optional. Resources that match all filters are fetched.',
   summary: 'Returns a collection of resources',

diff --git a/services/wiki/src/openapi/routes/resources/me.ts b/services/wiki/src/openapi/routes/resources/me.ts
@@ -12,6 +12,7 @@ registry.registerPath({
   method: 'get',
   tags: ['resources'],
   path: `${pathRoot.v1.resources}/me`,
+  operationId: 'listUserMeResources',
   summary: 'Get resources by logged in user',
   description:
     'Returns all the posted resources by a logged in user. In addition, if categorySlug query provided, returns only the resources posted in that category.',

diff --git a/services/wiki/src/openapi/routes/resources/patch.ts b/services/wiki/src/openapi/routes/resources/patch.ts
@@ -8,6 +8,7 @@ registry.registerPath({
   method: 'patch',
   tags: ['resources'],
   path: `${pathRoot.v1.resources}`,
+  operationId: 'patchResources',
   description: 'Allows a logged in user to modify his resources.',
   summary: 'Patch a resource',
   security: [{ [cookieAuth.name]: [] }],

diff --git a/services/wiki/src/openapi/routes/seen/create.ts b/services/wiki/src/openapi/routes/seen/create.ts
@@ -9,6 +9,7 @@ registry.registerPath({
   method: 'post',
   tags: ['seen'],
   path: `${pathRoot.v1.seen}/{resourceId}`,
+  operationId: 'postUserSeenResourcesById',
   description: 'Allows a logged in user to mark a resource as viewed.',
   summary: 'Mark a resource as viewed',
   security: [{ [cookieAuth.name]: [] }],

diff --git a/services/wiki/src/openapi/routes/topics/create.ts b/services/wiki/src/openapi/routes/topics/create.ts
@@ -10,6 +10,7 @@ registry.registerPath({
   method: 'post',
   tags: ['topics'],
   path: `${pathRoot.v1.topics}`,
+  operationId: 'postTopics',
   description:
     'Creates a new topic. The requestor has to be logged in and with role MENTOR or higher.',
   summary: 'Creates a new topic.',

diff --git a/services/wiki/src/openapi/routes/topics/get.ts b/services/wiki/src/openapi/routes/topics/get.ts
@@ -8,6 +8,7 @@ registry.registerPath({
   method: 'get',
   tags: ['topics'],
   path: `${pathRoot.v1.topics}`,
+  operationId: 'listTopics',
   description:
     'Returns a list of all topics. Filter by category id or category slug possible. If both filters are sent, will only search by category id.',
   summary: 'Returns topics. Filter by category possible.',

diff --git a/services/wiki/src/openapi/routes/topics/patch.ts b/services/wiki/src/openapi/routes/topics/patch.ts
@@ -10,6 +10,7 @@ registry.registerPath({
   method: 'patch',
   tags: ['topics'],
   path: `${pathRoot.v1.topics}`,
+  operationId: 'patchTopics',
   description:
     'Modifies an existing topic. The requestor has to be logged in and with role MENTOR or higher.',
   summary: 'Patch a topic.',

diff --git a/services/wiki/src/openapi/routes/types.ts b/services/wiki/src/openapi/routes/types.ts
@@ -9,6 +9,7 @@ registry.registerPath({
   method: 'get',
   tags: ['types'],
   path: `${pathRoot.v1.types}`,
+  operationId: 'listResourceTypes',
   description: 'Returns an array of all the resource types',
   summary: 'Returns resource types',
   responses: {