Skip to content

Commit

Permalink
Merge pull request #20 from ExtensionEngine/feature/docs
Browse files Browse the repository at this point in the history 
Docs
  • Loading branch information
@underscope
underscope authored Jun 6, 2019
2 parents 1061fd1 + ab2a0fc commit 983a737
Showing 1 changed file with 376 additions and 0 deletions.
376 changes: 376 additions & 0 deletions docs/postman-collection.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,376 @@
{
"info": {
"_postman_id": "160d85e6-8474-48c3-84eb-be7e595fd1ee",
"name": "TAPE",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Status",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/ping",
"host": [
"{{baseUrl}}"
],
"path": [
"ping"
]
}
},
"response": []
},
{
"name": "Learners",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"userIds\": [1,2,3]\n}"
},
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/register",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"register"
]
}
},
"response": []
},
{
"name": "Graph",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"repositoryId\": 1,\n \"nodes\": [\n {\n \"id\": 1,\n \"name\": \"Competency 1\",\n \"type\": \"COMPETENCY\",\n \"exams\": [\n {\n \"id\": 100\n },\n {\n \"id\": 101\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"Competency 2\",\n \"type\": \"COMPETENCY\",\n \"exams\": [\n {\n \"id\": 102\n },\n {\n \"id\": 103\n }\n ]\n },\n {\n \"id\": 3,\n \"type\": \"LEARNING_OBJECTIVE\",\n \"name\": \"Learning Objective 1\",\n \"relationships\": [\n {\n \"id\": 1,\n \"type\": \"PARENT\"\n }\n ]\n },\n {\n \"id\": 4,\n \"type\": \"LEARNING_OBJECTIVE\",\n \"name\": \"Learning Objective 2\",\n \"relationships\": [\n {\n \"id\": 1,\n \"type\": \"PARENT\"\n }\n ]\n },\n {\n \"id\": 5,\n \"type\": \"LEARNING_OBJECTIVE\",\n \"name\": \"Learning Objective 3\",\n \"relationships\": [\n {\n \"id\": 2,\n \"type\": \"PARENT\"\n }\n ]\n },\n {\n \"id\": 6,\n \"type\": \"LEARNING_OBJECTIVE\",\n \"name\": \"Learning Objective 4\",\n \"relationships\": [\n {\n \"id\": 2,\n \"type\": \"PARENT\"\n }\n ]\n },\n {\n \"id\": 7,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 1\",\n \"relationships\": [\n {\n \"id\": 3,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 50,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 200\n },\n {\n \"id\": 201\n },\n {\n \"id\": 202\n }\n ]\n },\n {\n \"id\": 8,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 2\",\n \"relationships\": [\n {\n \"id\": 3,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 51,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 203\n },\n {\n \"id\": 204\n },\n {\n \"id\": 205\n }\n ]\n },\n {\n \"id\": 9,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 3\",\n \"relationships\": [\n {\n \"id\": 4,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 52,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 206\n },\n {\n \"id\": 207\n },\n {\n \"id\": 208\n }\n ]\n },\n {\n \"id\": 10,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 4\",\n \"relationships\": [\n {\n \"id\": 4,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 53,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 209\n },\n {\n \"id\": 210\n },\n {\n \"id\": 211\n }\n ]\n },\n {\n \"id\": 11,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 5\",\n \"relationships\": [\n {\n \"id\": 5,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 54,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 212\n },\n {\n \"id\": 213\n },\n {\n \"id\": 214\n }\n ]\n },\n {\n \"id\": 12,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 6\",\n \"relationships\": [\n {\n \"id\": 5,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 55,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 215\n },\n {\n \"id\": 216\n },\n {\n \"id\": 217\n }\n ]\n },\n {\n \"id\": 13,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 7\",\n \"relationships\": [\n {\n \"id\": 6,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 56,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 218\n },\n {\n \"id\": 219\n },\n {\n \"id\": 220\n }\n ]\n },\n {\n \"id\": 14,\n \"type\": \"LESSON\",\n \"name\": \"Lesson 8\",\n \"relationships\": [\n {\n \"id\": 6,\n \"type\": \"PARENT\"\n }\n ],\n \"content\": [\n {\n \"id\": 57,\n \"type\": \"PAGE\"\n }\n ],\n \"assessments\": [\n {\n \"id\": 221\n },\n {\n \"id\": 222\n },\n {\n \"id\": 223\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/graph",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"graph"
]
}
},
"response": []
},
{
"name": "Graph",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/graph/{{repositoryId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"graph",
"{{repositoryId}}"
]
}
},
"response": []
},
{
"name": "Ungraded Event",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\t\n\t\"activityId\": 3,\n\t\"interactionStart\": 1559745048299,\n\t\"interactionEnd\": 1559745050631,\n\t\"progress\": 100,\n\t\"userId\": 1\n}"
},
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/event/ungraded",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"event",
"ungraded"
]
}
},
"response": []
},
{
"name": "Graded Event",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\t\n\t\"activityId\": 7,\n\t\"questionId\": 200,\n\t\"userId\": 1,\n\t\"isCorrect\": \"false\",\n\t\"answer\": { \"1\": \"Answer 2\" },\n\t\"interactionStart\": 1559745048299,\n\t\"interactionEnd\": 1559745050631\n}"
},
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/event/graded",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"event",
"graded"
]
}
},
"response": []
},
{
"name": "Cohort Progress",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/progress",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"progress"
]
}
},
"response": []
},
{
"name": "Cohort Stats",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/learner",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"learner"
],
"query": [
{
"key": "userId[]",
"value": "1",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "Learner Stats",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/learner/{{learnerId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"learner",
"{{learnerId}}"
]
}
},
"response": []
},
{
"name": "Ungraded Events",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/event/ungraded",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"event",
"ungraded"
],
"query": [
{
"key": "activityIds[]",
"value": "3",
"disabled": true
},
{
"key": "fromDate",
"value": "2019-06-01",
"disabled": true
},
{
"key": "toDate",
"value": "2019-06-07",
"disabled": true
},
{
"key": "uniqueViews",
"value": "true",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "Graded Events",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/cohort/{{cohortId}}/event/graded?",
"host": [
"{{baseUrl}}"
],
"path": [
"cohort",
"{{cohortId}}",
"event",
"graded"
],
"query": [
{
"key": "questionIds[]",
"value": "200",
"disabled": true
},
{
"key": "activityIds[]",
"value": "7",
"disabled": true
},
{
"key": "fromDate",
"value": "2019-06-06",
"disabled": true
},
{
"key": "toDate",
"value": "2019-06-07",
"disabled": true
}
]
}
},
"response": []
}
],
"event": [
{
"listen": "prerequest",
"script": {
"id": "5d61479a-d1aa-4502-aa9a-e1358e1e4586",
"type": "text/javascript",
"exec": [
"pm.request.headers.add({key: 'Authorization', value: pm.variables.get('token') })",
"pm.request.headers.add({key: 'Content-Type', value: 'application/json' })"
]
}
},
{
"listen": "test",
"script": {
"id": "20af7b4c-e869-4610-8121-ef65bd49ac3c",
"type": "text/javascript",
"exec": [
""
]
}
}
],
"variable": [
{
"id": "216c47f8-2589-42dd-85a1-a185ac8cb278",
"key": "token",
"value": "your_jwt_token",
"type": "string"
},
{
"id": "350ad6ea-0e6d-42e6-8933-3a631d750bb8",
"key": "baseUrl",
"value": "http://127.0.0.1:5000/api/v1",
"type": "string"
},
{
"id": "12c9bd0e-8c30-43c1-abfe-10e39aabfaf3",
"key": "cohortId",
"value": "1",
"type": "string"
},
{
"id": "f5ae1130-f30d-4d88-8f61-6397b37abe4b",
"key": "repositoryId",
"value": "1",
"type": "string"
},
{
"id": "444da792-3c39-4827-a529-211621e529cd",
"key": "learnerId",
"value": "1",
"type": "string"
}
]
}

0 comments on commit 983a737

Please sign in to comment.