From 60a1027b7ebbac57b4fb610890112c6bdb756297 Mon Sep 17 00:00:00 2001 From: Santiago Lo Coco Date: Tue, 20 Dec 2022 14:50:22 -0300 Subject: [PATCH] Update docs Co-authored-by: Ezequiel Bellver Co-authored-by: Juan Barmasch --- README.md | 6 + docs/bsition_postman.json | 428 +++++++++----------------------------- 2 files changed, 100 insertions(+), 334 deletions(-) diff --git a/README.md b/README.md index e18af75..bc516d6 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,14 @@ ### Presentación +#### Parcial + Puede verla en el siguiente [link](https://www.canva.com/design/DAFSnStE99g/k9QGkxyRYkvtTKGQK7vpTg/view). +#### Final + +Puede verla en el siguiente [link](https://www.canva.com/design/DAFVUEarNQ4/D4Bi_6SiJX2HKUG3563iVg/view). + ## Requerimientos Debe instalar: diff --git a/docs/bsition_postman.json b/docs/bsition_postman.json index f6a4967..43c7897 100644 --- a/docs/bsition_postman.json +++ b/docs/bsition_postman.json @@ -9,13 +9,12 @@ "name": "Create user", "protocolProfileBehavior": { "disabledSystemHeaders": { - "connection": true, - "accept-encoding": true, - "accept": true, "user-agent": true, + "accept": true, + "accept-encoding": true, + "connection": true, "host": true - }, - "strictSSL": true + } }, "request": { "auth": { @@ -65,8 +64,19 @@ "method": "POST", "header": [], "body": { - "mode": "raw", - "raw": "{\n \"username\": \"user\",\n \"password\": \"pass\"\n}", + "mode": "formdata", + "formdata": [ + { + "key": "username", + "value": "user", + "type": "default" + }, + { + "key": "password", + "value": "pass", + "type": "default" + } + ], "options": { "raw": { "language": "json" @@ -74,7 +84,7 @@ } }, "url": { - "raw": "http://localhost:8000/api/login", + "raw": "http://localhost:8000/api/token", "protocol": "http", "host": [ "localhost" @@ -82,7 +92,7 @@ "port": "8000", "path": [ "api", - "login" + "token" ] } }, @@ -94,7 +104,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://localhost:8000/api/users/1", + "raw": "http://localhost:8000/api/users/me", "protocol": "http", "host": [ "localhost" @@ -103,7 +113,7 @@ "path": [ "api", "users", - "1" + "me" ] } }, @@ -159,35 +169,6 @@ }, "response": [] }, - { - "name": "Create document", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"test-doc\",\n \"access\": [],\n \"owner\": \"usertest\",\n \"data\": \"Este es un documento de prueba.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/documents", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "documents" - ] - } - }, - "response": [] - }, { "name": "Get documents", "protocolProfileBehavior": { @@ -220,106 +201,6 @@ }, "response": [] }, - { - "name": "Update document (cambiar document_id)", - "request": { - "method": "PUT", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"doc-test\",\n \"data\": \"Este es un documento.\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/documents/{{document_id}}", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "documents", - "{{document_id}}" - ] - } - }, - "response": [] - }, - { - "name": "Get documents", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/documents", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "documents" - ] - } - }, - "response": [] - }, - { - "name": "Search documents", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/documents?query=*documento*", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "documents" - ], - "query": [ - { - "key": "query", - "value": "*documento*" - } - ] - } - }, - "response": [] - }, { "name": "Create document", "request": { @@ -349,44 +230,6 @@ }, "response": [] }, - { - "name": "Search documents", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/documents?query=*documento*", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "documents" - ], - "query": [ - { - "key": "query", - "value": "*documento*" - } - ] - } - }, - "response": [] - }, { "name": "Create table", "request": { @@ -477,133 +320,13 @@ "response": [] }, { - "name": "Add column", + "name": "Add sort", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"column\": \"custard\",\n \"type\": \"TEXT\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/tables/table-test", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "tables", - "table-test" - ] - } - }, - "response": [] - }, - { - "name": "Insert data", - "request": { - "method": "PUT", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"column_data\": [\"shell\", \"yes\"]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/tables/table-test", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "tables", - "table-test" - ] - } - }, - "response": [] - }, - { - "name": "Edit data", - "request": { - "method": "PUT", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"columns\": [\"custard\"],\n \"columns_data\": [\"no\"],\n \"row_number\": \"1\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/tables/table-test", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "tables", - "table-test" - ] - } - }, - "response": [] - }, - { - "name": "Insert data", - "request": { - "method": "PUT", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"column_data\": [\"main\", \"nein\"]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/tables/table-test", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "tables", - "table-test" - ] - } - }, - "response": [] - }, - { - "name": "Create sort", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{}", + "raw": "{\n \"property\": \"name\",\n \"order\": \"ASC\",\n \"priority\": 1\n}", "options": { "raw": { "language": "json" @@ -627,6 +350,40 @@ }, "response": [] }, + { + "name": "Sort table", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://localhost:8000/api/tables/3/sort", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8000", + "path": [ + "api", + "tables", + "3", + "sort" + ] + } + }, + "response": [] + }, { "name": "Add sort", "request": { @@ -676,7 +433,7 @@ } }, "url": { - "raw": "http://localhost:8000/api/tables/table-test/sort", + "raw": "http://localhost:8000/api/tables/3/sort", "protocol": "http", "host": [ "localhost" @@ -685,44 +442,13 @@ "path": [ "api", "tables", - "table-test", + "3", "sort" ] } }, "response": [] }, - { - "name": "Create filter", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8000/api/tables/table-test/filter", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8000", - "path": [ - "api", - "tables", - "table-test", - "filter" - ] - } - }, - "response": [] - }, { "name": "Add filter", "request": { @@ -787,6 +513,40 @@ } }, "response": [] + }, + { + "name": "Log out", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://localhost:8000/api/tables/table-test/filter", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8000", + "path": [ + "api", + "tables", + "table-test", + "filter" + ] + } + }, + "response": [] } ], "auth": { @@ -794,7 +554,7 @@ "bearer": [ { "key": "token", - "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXIiLCJleHAiOjE2Njk4ODI0Mjl9.ixmxpfw9FfJe0FfZNYIxCz8GXtxqXaN4kMzFn1p5q7A", + "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyOjkiLCJleHAiOjE2NzE2MjA4ODJ9.IppWpp3UgwjqZdPapo4z9uMN6jwfHpI84NONhA0OBDI", "type": "string" } ]