From 91ad712ec9647ff6b6de91f7c5f6cbedb5ccc6cc Mon Sep 17 00:00:00 2001 From: SebastienBtr Date: Sat, 14 Nov 2020 17:50:12 +0100 Subject: [PATCH] update doc files --- .../postman/article-postman.json | 90 ++++++++++++------- .../documentation/postman/auth-postman.json | 26 +++--- .../documentation/postman/cart-postman.json | 22 ++--- .../documentation/postman/user-postman.json | 42 ++++----- .../swagger/article-swagger.json | 3 +- .../documentation/swagger/auth-swagger.json | 8 +- .../documentation/swagger/cart-swagger.json | 6 +- .../documentation/swagger/user-swagger.json | 6 +- 8 files changed, 115 insertions(+), 88 deletions(-) mode change 100755 => 100644 services/documentation/postman/article-postman.json mode change 100755 => 100644 services/documentation/postman/cart-postman.json mode change 100755 => 100644 services/documentation/swagger/article-swagger.json mode change 100755 => 100644 services/documentation/swagger/cart-swagger.json diff --git a/services/documentation/postman/article-postman.json b/services/documentation/postman/article-postman.json old mode 100755 new mode 100644 index 7afff13..3698193 --- a/services/documentation/postman/article-postman.json +++ b/services/documentation/postman/article-postman.json @@ -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", @@ -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", @@ -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" @@ -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", @@ -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", @@ -130,7 +132,7 @@ }, "method" : "GET", "description" : { - "content" : "Get a specific article" + "content" : "Get a specific article; methodName: getArticleById" }, "header" : [ ] }, @@ -155,7 +157,7 @@ }, "method" : "PUT", "description" : { - "content" : "Update a specific article" + "content" : "Update a specific article; methodName: updateArticle" }, "header" : [ { "key" : "Content-Type", @@ -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", @@ -199,7 +201,7 @@ }, "method" : "PUT", "description" : { - "content" : "Update a specific article" + "content" : "Update a specific article; methodName: updateArticle" }, "header" : [ { "key" : "Content-Type", @@ -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", @@ -234,7 +236,7 @@ }, "method" : "PUT", "description" : { - "content" : "Update a specific article" + "content" : "Update a specific article; methodName: updateArticle" }, "header" : [ { "key" : "Content-Type", @@ -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" } }, @@ -268,7 +270,7 @@ }, "method" : "PUT", "description" : { - "content" : "Update a specific article" + "content" : "Update a specific article; methodName: updateArticle" }, "header" : [ { "key" : "Content-Type", @@ -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" } }, @@ -296,7 +298,7 @@ }, "method" : "POST", "description" : { - "content" : "Create an article" + "content" : "Create an article; methodName: createArticle" }, "header" : [ { "key" : "Content-Type", @@ -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", @@ -333,7 +335,7 @@ }, "method" : "POST", "description" : { - "content" : "Create an article" + "content" : "Create an article; methodName: createArticle" }, "header" : [ { "key" : "Content-Type", @@ -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", @@ -361,7 +363,7 @@ }, "method" : "POST", "description" : { - "content" : "Create an article" + "content" : "Create an article; methodName: createArticle" }, "header" : [ { "key" : "Content-Type", @@ -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" } }, @@ -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", @@ -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" } ], diff --git a/services/documentation/postman/auth-postman.json b/services/documentation/postman/auth-postman.json index 2773ffa..cf26c00 100644 --- a/services/documentation/postman/auth-postman.json +++ b/services/documentation/postman/auth-postman.json @@ -30,7 +30,7 @@ } } ], "body" : { - "raw" : "{\n \"email\" : \"2055c000259b\",\n \"password\" : \"b77535ea19b1\"\n}", + "raw" : "{\n \"email\" : \"42ac120b66e2\",\n \"password\" : \"324f78fde642\"\n}", "mode" : "raw" } }, @@ -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", @@ -95,7 +95,7 @@ } } ], "body" : { - "raw" : "{\n \"email\" : \"2055c000259b\",\n \"password\" : \"b77535ea19b1\"\n}", + "raw" : "{\n \"email\" : \"42ac120b66e2\",\n \"password\" : \"324f78fde642\"\n}", "mode" : "raw" } }, @@ -122,7 +122,7 @@ } } ], "body" : { - "raw" : "{\n \"email\" : \"2055c000259b\",\n \"password\" : \"b77535ea19b1\"\n}", + "raw" : "{\n \"email\" : \"42ac120b66e2\",\n \"password\" : \"324f78fde642\"\n}", "mode" : "raw" } }, @@ -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" } }, @@ -166,7 +166,7 @@ } } ], "response" : [ { - "name" : "Example 200 - unit", + "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/auth/sign-up", @@ -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", @@ -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" : { @@ -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" } }, diff --git a/services/documentation/postman/cart-postman.json b/services/documentation/postman/cart-postman.json old mode 100755 new mode 100644 index aae9654..f09d584 --- a/services/documentation/postman/cart-postman.json +++ b/services/documentation/postman/cart-postman.json @@ -3,9 +3,9 @@ "name" : "cart", "schema" : "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description" : { - "content" : "To simplify the POC, we consider that there is only one cart and we can operate on its elements" + "content" : "Service to manage carts, to simplify the POC, we consider that there is only one cart and we can operate on its elements" }, - "version" : "0.0.1" + "version" : "1.0.0" }, "item" : [ { "name" : "cart_items", @@ -51,7 +51,7 @@ }, "header" : [ ] }, - "body" : "[ {\n \"quantity\" : 1,\n \"articleName\" : \"8c77f6e99d18\",\n \"id\" : \"538566d2-c020-4555-8565-36c012e1ba43\",\n \"articlePrice\" : 1,\n \"articleId\" : \"a5172b3e-bd48-4e36-a75a-cfce82a6fac1\"\n} ]", + "body" : "[ {\n \"quantity\" : 1,\n \"articleName\" : \"af6caf5f4c2b\",\n \"id\" : \"a77b14ce-2950-4b10-ad3c-97a3b00a2765\",\n \"articlePrice\" : 1,\n \"articleId\" : \"8aab1411-f180-42bf-9c45-0b51e3efcb3c\"\n} ]", "code" : 200 } ], "type" : "item" @@ -76,7 +76,7 @@ } } ], "body" : { - "raw" : "{\n \"articleId\" : \"775805ad-db5b-4e27-93a8-6d03add1f67e\",\n \"articleName\" : \"bec2113e4f5a\",\n \"articlePrice\" : 1,\n \"quantity\" : 1\n}", + "raw" : "{\n \"articleId\" : \"62a6c89e-dffe-4a11-8abd-67ac38f3c3cb\",\n \"articleName\" : \"de8789e52595\",\n \"articlePrice\" : 1,\n \"quantity\" : 1\n}", "mode" : "raw" } }, @@ -113,11 +113,11 @@ } } ], "body" : { - "raw" : "{\n \"articleId\" : \"775805ad-db5b-4e27-93a8-6d03add1f67e\",\n \"articleName\" : \"bec2113e4f5a\",\n \"articlePrice\" : 1,\n \"quantity\" : 1\n}", + "raw" : "{\n \"articleId\" : \"62a6c89e-dffe-4a11-8abd-67ac38f3c3cb\",\n \"articleName\" : \"de8789e52595\",\n \"articlePrice\" : 1,\n \"quantity\" : 1\n}", "mode" : "raw" } }, - "body" : "{\n \"quantity\" : 1,\n \"articleName\" : \"cf4b9a3043e3\",\n \"id\" : \"8fe3b7a1-0195-4346-af14-e79fde1c19a3\",\n \"articlePrice\" : 1,\n \"articleId\" : \"8caceaeb-049c-4488-b533-6b5958710d2c\"\n}", + "body" : "{\n \"quantity\" : 1,\n \"articleName\" : \"a5d584e2b7f5\",\n \"id\" : \"2bcf52d7-7216-46cb-ba8c-4bec4cef3c29\",\n \"articlePrice\" : 1,\n \"articleId\" : \"59f7ec42-61a6-4035-bde6-292cb2df8513\"\n}", "code" : 201 }, { "name" : "Example 400 - unit", @@ -141,7 +141,7 @@ } } ], "body" : { - "raw" : "{\n \"articleId\" : \"775805ad-db5b-4e27-93a8-6d03add1f67e\",\n \"articleName\" : \"bec2113e4f5a\",\n \"articlePrice\" : 1,\n \"quantity\" : 1\n}", + "raw" : "{\n \"articleId\" : \"62a6c89e-dffe-4a11-8abd-67ac38f3c3cb\",\n \"articleName\" : \"de8789e52595\",\n \"articlePrice\" : 1,\n \"quantity\" : 1\n}", "mode" : "raw" } }, @@ -159,13 +159,13 @@ }, "method" : "PUT", "description" : { - "content" : "Checkout the items for the payment (in our POC this will update article's stocks and empty the cart); methodName: checkout" + "content" : "Checkout the items for the payment; methodName: checkout" }, "header" : [ ] }, "name" : "PUT /cart/items/checkout", "description" : { - "content" : "Checkout the items for the payment (in our POC this will update article's stocks and empty the cart); methodName: checkout" + "content" : "Checkout the items for the payment; methodName: checkout" }, "event" : [ { "listen" : "test", @@ -186,7 +186,7 @@ }, "method" : "PUT", "description" : { - "content" : "Checkout the items for the payment (in our POC this will update article's stocks and empty the cart); methodName: checkout" + "content" : "Checkout the items for the payment; methodName: checkout" }, "header" : [ ] }, @@ -269,7 +269,7 @@ "mode" : "raw" } }, - "body" : "{\n \"quantity\" : 1,\n \"articleName\" : \"a65b640148ca\",\n \"id\" : \"3a924b6b-8f82-46dc-bb16-6cad74912294\",\n \"articlePrice\" : 1,\n \"articleId\" : \"a9fab911-8d7a-474c-a4a8-6f11c61a8cd3\"\n}", + "body" : "{\n \"quantity\" : 1,\n \"articleName\" : \"6c91a556fbf2\",\n \"id\" : \"364f0093-1e3d-4992-a0a0-b9312b09fb34\",\n \"articlePrice\" : 1,\n \"articleId\" : \"cb25b89b-c841-4a23-85bb-550ba3c54232\"\n}", "code" : 200 }, { "name" : "Example 400 - unit", diff --git a/services/documentation/postman/user-postman.json b/services/documentation/postman/user-postman.json index 01e1cea..8934da1 100644 --- a/services/documentation/postman/user-postman.json +++ b/services/documentation/postman/user-postman.json @@ -5,7 +5,7 @@ "description" : { "content" : "Service to manage users" }, - "version" : "1.0.1" + "version" : "1.0.0" }, "item" : [ { "name" : "users", @@ -63,7 +63,7 @@ }, "header" : [ ] }, - "body" : "[ {\n \"updatedAt\" : \"2020-11-07T14:24:30.337Z\",\n \"email\" : \"a8ed5478d629\",\n \"lastName\" : \"c4a431b5ae47\",\n \"createdAt\" : \"2020-11-07T14:24:30.337Z\",\n \"firstName\" : \"d54c1c6f10b4\",\n \"id\" : \"b22cebac-f4cb-421c-be8e-ae908a0f459c\"\n} ]", + "body" : "[ {\n \"updatedAt\" : \"2020-11-14T16:41:42.290Z\",\n \"email\" : \"4ad4d0f76da0\",\n \"lastName\" : \"0cb2dd52857f\",\n \"createdAt\" : \"2020-11-14T16:41:42.290Z\",\n \"firstName\" : \"7377bc3e163f\",\n \"id\" : \"3532c41d-ef0e-4666-b7be-6548ea8b5c59\"\n} ]", "code" : 200 }, { "name" : "Example 400 - unit", @@ -146,7 +146,7 @@ }, "header" : [ ] }, - "body" : "{\n \"updatedAt\" : \"2020-11-07T14:24:30.337Z\",\n \"email\" : \"7db6cb21cb8f\",\n \"lastName\" : \"1a5cfaf91e56\",\n \"createdAt\" : \"2020-11-07T14:24:30.337Z\",\n \"firstName\" : \"8b040f6155f2\",\n \"id\" : \"63a291a9-82b7-40b5-bd71-cea6300ad5f6\"\n}", + "body" : "{\n \"updatedAt\" : \"2020-11-14T16:41:42.290Z\",\n \"email\" : \"dd4f2d33de6c\",\n \"lastName\" : \"f53fc163df8f\",\n \"createdAt\" : \"2020-11-14T16:41:42.290Z\",\n \"firstName\" : \"bb240daf4dda\",\n \"id\" : \"034acabc-d3c3-431d-8ec6-2dc262e636a5\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", @@ -195,7 +195,7 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"728604980ff9\",\n \"lastName\" : \"f57955a59d33\",\n \"email\" : \"e64518fa927e\",\n \"password\" : \"f32f04ebe6d9\"\n}", + "raw" : "{\n \"firstName\" : \"2bd7dc836fd9\",\n \"lastName\" : \"0a5b0e2feb0c\",\n \"email\" : \"1198fa6ea75f\",\n \"password\" : \"59c432f826bd\"\n}", "mode" : "raw" } }, @@ -232,11 +232,11 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"728604980ff9\",\n \"lastName\" : \"f57955a59d33\",\n \"email\" : \"e64518fa927e\",\n \"password\" : \"f32f04ebe6d9\"\n}", + "raw" : "{\n \"firstName\" : \"2bd7dc836fd9\",\n \"lastName\" : \"0a5b0e2feb0c\",\n \"email\" : \"1198fa6ea75f\",\n \"password\" : \"59c432f826bd\"\n}", "mode" : "raw" } }, - "body" : "{\n \"updatedAt\" : \"2020-11-07T14:24:30.337Z\",\n \"email\" : \"b205c7190385\",\n \"lastName\" : \"1dac52de474c\",\n \"createdAt\" : \"2020-11-07T14:24:30.337Z\",\n \"firstName\" : \"86fe348d5eea\",\n \"id\" : \"67ae47b2-5947-4d2f-8c3b-7ce2f37f1a2a\"\n}", + "body" : "{\n \"updatedAt\" : \"2020-11-14T16:41:42.290Z\",\n \"email\" : \"b4de013e65b9\",\n \"lastName\" : \"51a210392e5a\",\n \"createdAt\" : \"2020-11-14T16:41:42.290Z\",\n \"firstName\" : \"c9c4989dab36\",\n \"id\" : \"cf364f48-a7b2-4285-aff7-788a4572db3b\"\n}", "code" : 201 }, { "name" : "Example 400 - unit", @@ -260,7 +260,7 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"728604980ff9\",\n \"lastName\" : \"f57955a59d33\",\n \"email\" : \"e64518fa927e\",\n \"password\" : \"f32f04ebe6d9\"\n}", + "raw" : "{\n \"firstName\" : \"2bd7dc836fd9\",\n \"lastName\" : \"0a5b0e2feb0c\",\n \"email\" : \"1198fa6ea75f\",\n \"password\" : \"59c432f826bd\"\n}", "mode" : "raw" } }, @@ -287,7 +287,7 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"728604980ff9\",\n \"lastName\" : \"f57955a59d33\",\n \"email\" : \"e64518fa927e\",\n \"password\" : \"f32f04ebe6d9\"\n}", + "raw" : "{\n \"firstName\" : \"2bd7dc836fd9\",\n \"lastName\" : \"0a5b0e2feb0c\",\n \"email\" : \"1198fa6ea75f\",\n \"password\" : \"59c432f826bd\"\n}", "mode" : "raw" } }, @@ -322,7 +322,7 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"23005c32346d\",\n \"lastName\" : \"1db2f6c372fc\",\n \"email\" : \"637418c94579\"\n}", + "raw" : "{\n \"firstName\" : \"06e5c0c0bfbe\",\n \"lastName\" : \"7ead700576d2\",\n \"email\" : \"55d54ea96c60\"\n}", "mode" : "raw" } }, @@ -366,11 +366,11 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"23005c32346d\",\n \"lastName\" : \"1db2f6c372fc\",\n \"email\" : \"637418c94579\"\n}", + "raw" : "{\n \"firstName\" : \"06e5c0c0bfbe\",\n \"lastName\" : \"7ead700576d2\",\n \"email\" : \"55d54ea96c60\"\n}", "mode" : "raw" } }, - "body" : "{\n \"updatedAt\" : \"2020-11-07T14:24:30.337Z\",\n \"email\" : \"6cfd14097c9f\",\n \"lastName\" : \"d78de82b5e4e\",\n \"createdAt\" : \"2020-11-07T14:24:30.337Z\",\n \"firstName\" : \"ef9b0f852423\",\n \"id\" : \"43fe22b3-5598-4ae9-bfaa-c8e7b2c70725\"\n}", + "body" : "{\n \"updatedAt\" : \"2020-11-14T16:41:42.290Z\",\n \"email\" : \"0f21ad294029\",\n \"lastName\" : \"6e410dafdebc\",\n \"createdAt\" : \"2020-11-14T16:41:42.290Z\",\n \"firstName\" : \"50dad62593dc\",\n \"id\" : \"02aa52fb-2fd1-4f9a-a204-d2f243dd8438\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", @@ -401,7 +401,7 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"23005c32346d\",\n \"lastName\" : \"1db2f6c372fc\",\n \"email\" : \"637418c94579\"\n}", + "raw" : "{\n \"firstName\" : \"06e5c0c0bfbe\",\n \"lastName\" : \"7ead700576d2\",\n \"email\" : \"55d54ea96c60\"\n}", "mode" : "raw" } }, @@ -435,13 +435,13 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"23005c32346d\",\n \"lastName\" : \"1db2f6c372fc\",\n \"email\" : \"637418c94579\"\n}", + "raw" : "{\n \"firstName\" : \"06e5c0c0bfbe\",\n \"lastName\" : \"7ead700576d2\",\n \"email\" : \"55d54ea96c60\"\n}", "mode" : "raw" } }, "code" : 400 }, { - "name" : "Example 412 - unit", + "name" : "Example 422 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:id", @@ -469,11 +469,11 @@ } } ], "body" : { - "raw" : "{\n \"firstName\" : \"23005c32346d\",\n \"lastName\" : \"1db2f6c372fc\",\n \"email\" : \"637418c94579\"\n}", + "raw" : "{\n \"firstName\" : \"06e5c0c0bfbe\",\n \"lastName\" : \"7ead700576d2\",\n \"email\" : \"55d54ea96c60\"\n}", "mode" : "raw" } }, - "code" : 412 + "code" : 422 } ], "type" : "item" }, { @@ -504,7 +504,7 @@ } } ], "body" : { - "raw" : "{\n \"password\" : \"77f1a01b6510\"\n}", + "raw" : "{\n \"password\" : \"be14a232d7b5\"\n}", "mode" : "raw" } }, @@ -548,11 +548,11 @@ } } ], "body" : { - "raw" : "{\n \"password\" : \"77f1a01b6510\"\n}", + "raw" : "{\n \"password\" : \"be14a232d7b5\"\n}", "mode" : "raw" } }, - "body" : "{\n \"updatedAt\" : \"2020-11-07T14:24:30.337Z\",\n \"email\" : \"c2a8134de22a\",\n \"lastName\" : \"4cade6e838c4\",\n \"createdAt\" : \"2020-11-07T14:24:30.337Z\",\n \"firstName\" : \"bfa178599874\",\n \"id\" : \"50675bf2-78d9-4f7e-91d8-fd4ba6844888\"\n}", + "body" : "{\n \"updatedAt\" : \"2020-11-14T16:41:42.290Z\",\n \"email\" : \"e4aa19df0eb2\",\n \"lastName\" : \"9f184f0d45e9\",\n \"createdAt\" : \"2020-11-14T16:41:42.290Z\",\n \"firstName\" : \"f2de68e8f660\",\n \"id\" : \"935bd432-1de7-43ea-8655-50e737447809\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", @@ -583,7 +583,7 @@ } } ], "body" : { - "raw" : "{\n \"password\" : \"77f1a01b6510\"\n}", + "raw" : "{\n \"password\" : \"be14a232d7b5\"\n}", "mode" : "raw" } }, @@ -617,7 +617,7 @@ } } ], "body" : { - "raw" : "{\n \"password\" : \"77f1a01b6510\"\n}", + "raw" : "{\n \"password\" : \"be14a232d7b5\"\n}", "mode" : "raw" } }, diff --git a/services/documentation/swagger/article-swagger.json b/services/documentation/swagger/article-swagger.json old mode 100755 new mode 100644 index b247cbf..3bfa133 --- a/services/documentation/swagger/article-swagger.json +++ b/services/documentation/swagger/article-swagger.json @@ -2,7 +2,8 @@ "swagger": "2.0", "info": { "title": "article", - "version": "0.0.1" + "description": "Service to manage articles, an article is an item of an e-commerce website.", + "version": "1.0.0" }, "consumes": [ "application/json" diff --git a/services/documentation/swagger/auth-swagger.json b/services/documentation/swagger/auth-swagger.json index ecb70ef..78ad770 100644 --- a/services/documentation/swagger/auth-swagger.json +++ b/services/documentation/swagger/auth-swagger.json @@ -53,14 +53,14 @@ } ], "responses": { - "200": { - "description": "200 response" + "204": { + "description": "204 response" }, "400": { "description": "400 response" }, - "412": { - "description": "412 response" + "422": { + "description": "422 response" } } } diff --git a/services/documentation/swagger/cart-swagger.json b/services/documentation/swagger/cart-swagger.json old mode 100755 new mode 100644 index 4c361eb..70a7486 --- a/services/documentation/swagger/cart-swagger.json +++ b/services/documentation/swagger/cart-swagger.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "cart", - "description": "To simplify the POC, we consider that there is only one cart and we can operate on its elements", - "version": "0.0.1" + "description": "Service to manage carts, to simplify the POC, we consider that there is only one cart and we can operate on its elements", + "version": "1.0.0" }, "consumes": [ "application/json" @@ -54,7 +54,7 @@ }, "/cart/items/checkout": { "put": { - "description": "Checkout the items for the payment (in our POC this will update article's stocks and empty the cart); methodName: checkout", + "description": "Checkout the items for the payment; methodName: checkout", "parameters": [], "responses": { "204": { diff --git a/services/documentation/swagger/user-swagger.json b/services/documentation/swagger/user-swagger.json index 0055841..b5635be 100644 --- a/services/documentation/swagger/user-swagger.json +++ b/services/documentation/swagger/user-swagger.json @@ -3,7 +3,7 @@ "info": { "title": "user", "description": "Service to manage users", - "version": "1.0.1" + "version": "1.0.0" }, "consumes": [ "application/json" @@ -120,8 +120,8 @@ "404": { "description": "404 response" }, - "412": { - "description": "412 response" + "422": { + "description": "422 response" } } },