Skip to content

Commit

Permalink
update doc files
Browse files Browse the repository at this point in the history
  • Loading branch information
@SebastienBtr
SebastienBtr committed Nov 14, 2020
1 parent 86bc987 commit 91ad712
Show file tree
Hide file tree
Showing 8 changed files with 115 additions and 88 deletions.
90 changes: 58 additions & 32 deletions services/documentation/postman/article-postman.json
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
"info" : {
"name" : "article",
"schema" : "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description" : { },
"version" : "0.0.1"
"description" : {
"content" : "Service to manage articles, an article is an item of an e-commerce website."
},
"version" : "1.0.0"
},
"item" : [ {
"name" : "articles",
Expand All @@ -18,13 +20,13 @@
},
"method" : "GET",
"description" : {
"content" : "Get all the articles"
"content" : "Get all the articles; methodName: getAllArticles"
},
"header" : [ ]
},
"name" : "GET /articles",
"description" : {
"content" : "Get all the articles"
"content" : "Get all the articles; methodName: getAllArticles"
},
"event" : [ {
"listen" : "test",
Expand All @@ -45,11 +47,11 @@
},
"method" : "GET",
"description" : {
"content" : "Get all the articles"
"content" : "Get all the articles; methodName: getAllArticles"
},
"header" : [ ]
},
"body" : "[ {\n \"id\" : \"ccbb80e2-cdf9-4e8c-aa60-dfc8dca2d21e\",\n \"name\" : \"6f978d7331e7\",\n \"stock\" : 1,\n \"price\" : 1\n} ]",
"body" : "[ {\n \"id\" : \"c708de77-67ad-4098-9c2d-e7c67bafa924\",\n \"name\" : \"da3e291645b2\",\n \"stock\" : 1,\n \"price\" : 1\n} ]",
"code" : 200
} ],
"type" : "item"
Expand All @@ -71,13 +73,13 @@
},
"method" : "GET",
"description" : {
"content" : "Get a specific article"
"content" : "Get a specific article; methodName: getArticleById"
},
"header" : [ ]
},
"name" : "GET /articles/:id",
"description" : {
"content" : "Get a specific article"
"content" : "Get a specific article; methodName: getArticleById"
},
"event" : [ {
"listen" : "test",
Expand Down Expand Up @@ -105,11 +107,11 @@
},
"method" : "GET",
"description" : {
"content" : "Get a specific article"
"content" : "Get a specific article; methodName: getArticleById"
},
"header" : [ ]
},
"body" : "{\n \"id\" : \"d5224ea7-e677-4274-a16c-4e88e41ac175\",\n \"name\" : \"c4c1d27a3b25\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"body" : "{\n \"id\" : \"650601f3-87ef-450c-801e-1655eb17e8c4\",\n \"name\" : \"dfa07e300474\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"code" : 200
}, {
"name" : "Example 404 - unit",
Expand All @@ -130,7 +132,7 @@
},
"method" : "GET",
"description" : {
"content" : "Get a specific article"
"content" : "Get a specific article; methodName: getArticleById"
},
"header" : [ ]
},
Expand All @@ -155,7 +157,7 @@
},
"method" : "PUT",
"description" : {
"content" : "Update a specific article"
"content" : "Update a specific article; methodName: updateArticle"
},
"header" : [ {
"key" : "Content-Type",
Expand All @@ -165,13 +167,13 @@
}
} ],
"body" : {
"raw" : "{\n \"name\" : \"9d9cf423bbfb\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"raw" : "{\n \"name\" : \"4eded4dd0abe\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"mode" : "raw"
}
},
"name" : "PUT /articles/:id",
"description" : {
"content" : "Update a specific article"
"content" : "Update a specific article; methodName: updateArticle"
},
"event" : [ {
"listen" : "test",
Expand Down Expand Up @@ -199,7 +201,7 @@
},
"method" : "PUT",
"description" : {
"content" : "Update a specific article"
"content" : "Update a specific article; methodName: updateArticle"
},
"header" : [ {
"key" : "Content-Type",
Expand All @@ -209,11 +211,11 @@
}
} ],
"body" : {
"raw" : "{\n \"name\" : \"9d9cf423bbfb\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"raw" : "{\n \"name\" : \"4eded4dd0abe\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"mode" : "raw"
}
},
"body" : "{\n \"id\" : \"dccc17bb-a49c-4295-8e9f-d94a316194ce\",\n \"name\" : \"2fc35c535b99\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"body" : "{\n \"id\" : \"264c18da-a5ee-40b1-a0c1-0ad637b9deee\",\n \"name\" : \"aa22420624cb\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"code" : 200
}, {
"name" : "Example 404 - unit",
Expand All @@ -234,7 +236,7 @@
},
"method" : "PUT",
"description" : {
"content" : "Update a specific article"
"content" : "Update a specific article; methodName: updateArticle"
},
"header" : [ {
"key" : "Content-Type",
Expand All @@ -244,7 +246,7 @@
}
} ],
"body" : {
"raw" : "{\n \"name\" : \"9d9cf423bbfb\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"raw" : "{\n \"name\" : \"4eded4dd0abe\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"mode" : "raw"
}
},
Expand All @@ -268,7 +270,7 @@
},
"method" : "PUT",
"description" : {
"content" : "Update a specific article"
"content" : "Update a specific article; methodName: updateArticle"
},
"header" : [ {
"key" : "Content-Type",
Expand All @@ -278,7 +280,7 @@
}
} ],
"body" : {
"raw" : "{\n \"name\" : \"9d9cf423bbfb\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"raw" : "{\n \"name\" : \"4eded4dd0abe\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"mode" : "raw"
}
},
Expand All @@ -296,7 +298,7 @@
},
"method" : "POST",
"description" : {
"content" : "Create an article"
"content" : "Create an article; methodName: createArticle"
},
"header" : [ {
"key" : "Content-Type",
Expand All @@ -306,13 +308,13 @@
}
} ],
"body" : {
"raw" : "{\n \"name\" : \"72a5f8c72125\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"raw" : "{\n \"name\" : \"3bfc0eb1b8d7\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"mode" : "raw"
}
},
"name" : "POST /articles",
"description" : {
"content" : "Create an article"
"content" : "Create an article; methodName: createArticle"
},
"event" : [ {
"listen" : "test",
Expand All @@ -333,7 +335,7 @@
},
"method" : "POST",
"description" : {
"content" : "Create an article"
"content" : "Create an article; methodName: createArticle"
},
"header" : [ {
"key" : "Content-Type",
Expand All @@ -343,11 +345,11 @@
}
} ],
"body" : {
"raw" : "{\n \"name\" : \"72a5f8c72125\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"raw" : "{\n \"name\" : \"3bfc0eb1b8d7\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"mode" : "raw"
}
},
"body" : "{\n \"id\" : \"0ae5882f-4df6-4c0e-bdd2-98bc9727fcad\",\n \"name\" : \"30f4989abcd7\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"body" : "{\n \"id\" : \"bd6ed470-bf6b-47d8-8a2c-214671c5151f\",\n \"name\" : \"90c190a05e7f\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"code" : 201
}, {
"name" : "Example 400 - unit",
Expand All @@ -361,7 +363,7 @@
},
"method" : "POST",
"description" : {
"content" : "Create an article"
"content" : "Create an article; methodName: createArticle"
},
"header" : [ {
"key" : "Content-Type",
Expand All @@ -371,7 +373,7 @@
}
} ],
"body" : {
"raw" : "{\n \"name\" : \"72a5f8c72125\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"raw" : "{\n \"name\" : \"3bfc0eb1b8d7\",\n \"stock\" : 1,\n \"price\" : 1\n}",
"mode" : "raw"
}
},
Expand All @@ -396,13 +398,13 @@
},
"method" : "DELETE",
"description" : {
"content" : "Delete a specific article"
"content" : "Delete a specific article; methodName: deleteArticle"
},
"header" : [ ]
},
"name" : "DELETE /articles/:id",
"description" : {
"content" : "Delete a specific article"
"content" : "Delete a specific article; methodName: deleteArticle"
},
"response" : [ {
"name" : "Example 204 - unit",
Expand All @@ -423,11 +425,35 @@
},
"method" : "DELETE",
"description" : {
"content" : "Delete a specific article"
"content" : "Delete a specific article; methodName: deleteArticle"
},
"header" : [ ]
},
"code" : 204
}, {
"name" : "Example 404 - unit",
"originalRequest" : {
"url" : {
"raw" : "{{BASE_URL}}/articles/:id",
"host" : [ "{{BASE_URL}}" ],
"path" : [ "articles", ":id" ],
"query" : [ ],
"variable" : [ {
"key" : "id",
"value" : "{{id}}",
"description" : {
"content" : "Type: uuid | Required: true"
},
"disabled" : false
} ]
},
"method" : "DELETE",
"description" : {
"content" : "Delete a specific article; methodName: deleteArticle"
},
"header" : [ ]
},
"code" : 404
} ],
"type" : "item"
} ],
Expand Down
26 changes: 13 additions & 13 deletions services/documentation/postman/auth-postman.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
}
} ],
"body" : {
"raw" : "{\n \"email\" : \"2055c000259b\",\n \"password\" : \"b77535ea19b1\"\n}",
"raw" : "{\n \"email\" : \"42ac120b66e2\",\n \"password\" : \"324f78fde642\"\n}",
"mode" : "raw"
}
},
Expand Down Expand Up @@ -67,11 +67,11 @@
}
} ],
"body" : {
"raw" : "{\n \"email\" : \"2055c000259b\",\n \"password\" : \"b77535ea19b1\"\n}",
"raw" : "{\n \"email\" : \"42ac120b66e2\",\n \"password\" : \"324f78fde642\"\n}",
"mode" : "raw"
}
},
"body" : "{\n \"accessToken\" : \"59ff1e162d0c\"\n}",
"body" : "{\n \"accessToken\" : \"dcc0d30db497\"\n}",
"code" : 200
}, {
"name" : "Example 400 - unit",
Expand All @@ -95,7 +95,7 @@
}
} ],
"body" : {
"raw" : "{\n \"email\" : \"2055c000259b\",\n \"password\" : \"b77535ea19b1\"\n}",
"raw" : "{\n \"email\" : \"42ac120b66e2\",\n \"password\" : \"324f78fde642\"\n}",
"mode" : "raw"
}
},
Expand All @@ -122,7 +122,7 @@
}
} ],
"body" : {
"raw" : "{\n \"email\" : \"2055c000259b\",\n \"password\" : \"b77535ea19b1\"\n}",
"raw" : "{\n \"email\" : \"42ac120b66e2\",\n \"password\" : \"324f78fde642\"\n}",
"mode" : "raw"
}
},
Expand Down Expand Up @@ -150,7 +150,7 @@
}
} ],
"body" : {
"raw" : "{\n \"firstName\" : \"b02f417ee8a5\",\n \"lastName\" : \"4d7a59a4a96b\",\n \"email\" : \"be999b3ee0e0\",\n \"password\" : \"e03c36660258\"\n}",
"raw" : "{\n \"firstName\" : \"a18fd8b5a34f\",\n \"lastName\" : \"c6c9c5c463a5\",\n \"email\" : \"ab3dd111b5a8\",\n \"password\" : \"b140a849a926\"\n}",
"mode" : "raw"
}
},
Expand All @@ -166,7 +166,7 @@
}
} ],
"response" : [ {
"name" : "Example 200 - unit",
"name" : "Example 204 - unit",
"originalRequest" : {
"url" : {
"raw" : "{{BASE_URL}}/auth/sign-up",
Expand All @@ -187,13 +187,13 @@
}
} ],
"body" : {
"raw" : "{\n \"firstName\" : \"b02f417ee8a5\",\n \"lastName\" : \"4d7a59a4a96b\",\n \"email\" : \"be999b3ee0e0\",\n \"password\" : \"e03c36660258\"\n}",
"raw" : "{\n \"firstName\" : \"a18fd8b5a34f\",\n \"lastName\" : \"c6c9c5c463a5\",\n \"email\" : \"ab3dd111b5a8\",\n \"password\" : \"b140a849a926\"\n}",
"mode" : "raw"
}
},
"code" : 200
"code" : 204
}, {
"name" : "Example 412 - unit",
"name" : "Example 422 - unit",
"originalRequest" : {
"url" : {
"raw" : "{{BASE_URL}}/auth/sign-up",
Expand All @@ -214,11 +214,11 @@
}
} ],
"body" : {
"raw" : "{\n \"firstName\" : \"b02f417ee8a5\",\n \"lastName\" : \"4d7a59a4a96b\",\n \"email\" : \"be999b3ee0e0\",\n \"password\" : \"e03c36660258\"\n}",
"raw" : "{\n \"firstName\" : \"a18fd8b5a34f\",\n \"lastName\" : \"c6c9c5c463a5\",\n \"email\" : \"ab3dd111b5a8\",\n \"password\" : \"b140a849a926\"\n}",
"mode" : "raw"
}
},
"code" : 412
"code" : 422
}, {
"name" : "Example 400 - unit",
"originalRequest" : {
Expand All @@ -241,7 +241,7 @@
}
} ],
"body" : {
"raw" : "{\n \"firstName\" : \"b02f417ee8a5\",\n \"lastName\" : \"4d7a59a4a96b\",\n \"email\" : \"be999b3ee0e0\",\n \"password\" : \"e03c36660258\"\n}",
"raw" : "{\n \"firstName\" : \"a18fd8b5a34f\",\n \"lastName\" : \"c6c9c5c463a5\",\n \"email\" : \"ab3dd111b5a8\",\n \"password\" : \"b140a849a926\"\n}",
"mode" : "raw"
}
},
Expand Down
Loading

0 comments on commit 91ad712

Please sign in to comment.