Merge pull request #15 from weaponsforge/dev

v1.0.2

Author: weaponsforge

README.md

@@ -2,7 +2,7 @@
 
 **apidocs-swagger-ui** features a simple Todo notes-taking CRUP API borrowed from [`todo-next`](https://github.com/weaponsforge/todo-next)'s server.
 
-This repository aims to test using [swagger-ui](https://github.com/swagger-api/swagger-ui) for creating an modern, responsive and interactive REST API documentations and to familiarize oneself with the [OpenAPI](https://spec.openapis.org/oas/v3.1.0) specifications, v3.1.0 as of this writing.
+This repository aims to test using [swagger-ui](https://github.com/swagger-api/swagger-ui) for creating modern, responsive and interactive REST API documentations and to familiarize oneself with the [OpenAPI](https://spec.openapis.org/oas/v3.1.0) specifications, v3.1.0 as of this writing.
 
 ![screenshot](/assets/thumbnail.png)
 

docs/src/swagger/swagger-config.yaml

@@ -35,6 +35,10 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/Todo'
+            example:
+              title: Read a Book
+              description: Read books about the Earth
+              content: Earth is the 3rd planet on the solar system, 3/4 made up of water
         required: true
       responses:
         '200':
@@ -56,11 +60,16 @@ paths:
       description: Update an existing Todo by ID
       operationId: updateTodo
       requestBody:
-        description: Update an existing Todo in the database. The `_id` field is required while the `title`, `description` and `content` fields are optional.
+        description: Update an existing Todo in the database. The `id` field is required while the `title`, `description` and `content` fields are optional.
         content:
           application/json:
             schema:
               $ref: '#/components/schemas/Todo'
+            example:
+              id: 63027bf42e28a411ed43b440
+              title: Play a Game
+              description: Games to play this week
+              content: Choices are tic-tac-toe, hide and seek and jumping rope
         required: true
       responses:
         '200':
@@ -80,7 +89,7 @@ paths:
       tags:
         - todo
       summary: Deletes a Todo
-      descriptionn: Delete a Todo
+      description: Delete a Todo by ID. Returns the data of a deleted Todo, on successful deletion.
       operationId: deleteTodo
       parameters:
         - name: id
@@ -149,7 +158,7 @@ components:
       properties:
         _id:
           type: string
-          example: ggdasu34773647f
+          example: 63027c032e28a411ed43b442
         title:
           type: string
           example: My Favorite Things
@@ -159,6 +168,12 @@ components:
         content:
           type: string
           example: The things I love in this world is Brownie and you.
+        createdAt:
+          type: date-time
+          example: 2022-08-21T18:40:03.512Z
+        updatedAt:
+          type: date-time
+          example: 2022-08-22T11:06:09.245Z
   requestBodies:
     Todo:
       description: Todo object that needs to be added to the database

src/classes/todo/todo.js

@@ -32,8 +32,7 @@ class Todo {
    * @returns {Object} Updated Todo
    */
   async updatetodo (params) {
-    const id = params._id
-    const keys = ['title', 'description', 'content']
+    const keys = ['id', 'title', 'description', 'content']
 
     const data = keys.reduce((acc, item) => {
       if (params[item] !== undefined) {
@@ -45,7 +44,7 @@ class Todo {
 
     try {
       const result = await TodoSchema.findOneAndUpdate(
-        { _id: id },
+        { _id: data.id },
         data,
         { returnOriginal: false }
       )

src/controllers/todo.js

@@ -19,11 +19,11 @@ module.exports.createTodo = async (req, res, next) => {
 
 // Update an existing Todo document
 module.exports.updateTodo = async (req, res, next) => {
-  const { _id, title, description, content } = req.body
+  const { id, title, description, content } = req.body
 
   try {
     const doc = await Todo.updatetodo({
-      _id,
+      id,
       title,
       description,
       content

src/index.js

@@ -1,4 +1,6 @@
 require('dotenv').config()
+require('./utils/db')
+
 const express = require('express')
 const cors = require('cors')
 const cookieParser = require('cookie-parser')
@@ -8,7 +10,6 @@ const PORT = process.env.PORT || 3001
 
 const { corsOptions } = require('./utils/cors_options')
 const controllers = require('./controllers')
-require('./utils/db')
 
 // Enable if you're behind a reverse proxy (i.e., Heroku)
 app.set('trust proxy', 1)