NodeTodo/api.doc.json at master · simonbassey/NodeTodo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
    "openapi":"3.0.1",
    "info": {
        "title": "NodeTodo",
        "description":"Node/Typescript API project starter pack",
        "contact": {
            "name": "simonbassey",
            "email":"simon.dev.bassey@gmail.com",
            "url":"https://github.com/simonbassey"
        },
        "licences": {
            "name": "Apache 2.0",
            "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
        }
    },
    "schemes":["http"],
    "host": "http://localhost:3000",
    "basePath":"http://localhost:3000/api",
    "paths":{
        "/api/todos": {
            "summary": "Todos",
            "get": {
                "summary":"Get Todo List",
                "description": "Returns a list of todos",
                "responses": {
                    "200": {
                        "description": "A list of available todos",
                        "content": {
                            "application/json": {
                              "schema": {
                                "type": "array",
                                "items": {"$ref": "#/components/schemas/TodoItem"}
                              }
                            }
                          }
                    }
                }
            }
        },
        "/api/todos/{id}": {
            "get":{
                "summary": "Gets a Todo",
                "description": "Gets the details of a todo by the provided Id",
                "parameters": {
                    "name": "id",
                    "in": "path",
                    "required": "true",
                    "description": "The Id of the todo to update",
                    "type": "string"
                },
                "responses":{
                    "200": {
                        "description": "A Todo documents",
                        "content": {
                            "application/json": {
                              "schema": {
                                "type": "object",
                                "$ref": "#/components/schemas/TodoItem"
                              }
                            }
                        }
                    }
                }
            }
        },
        "/api/todos/create": {
            "post": {
                "summary": "Create a new Todo",
                "description": "Creates and returns a new Todo list",
                "requestBody": {
                    "content": {
                        "application/json":{
                            "schema":{
                                "$ref":"#/components/schemas/TodoCreateRequest"
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "TodoItem": {
                "type":"object",
                "properties": {
                    "completed": {
                        "type": "boolean"
                    },
                    "_id": { "type": "string"},
                    "title": { "type": "string"},
                    "description": { "type": "string"},
                    "userId": { "type": "string"},
                    "createdDate": { "type": "date"},
                    "lastUpdated": { "type": "date"}
                }
            },
            "TodoCreateRequest": {
                "type":"object",
                "properties": {
                    "status": {"type": "boolean"},
                    "title": { "type": "string"},
                    "description": { "type": "string"}
                }
            }
        }
    }
}