Web API of kNODEledge (0.1.0)

Download OpenAPI specification:

App to Create Graphically-Summarized Notes in Three Steps

Projects

Get list of projects

query Parameters

userId

required

string

Example: userId=auth0|65a3d656ca600978b0f9501b

User ID

Responses

Response samples

200
400
500

Content type

application/json

{"projects": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Project",
"description": "This is my project"
}
]
}

Find project

query Parameters

userId required	string Example: userId=auth0\|65a3d656ca600978b0f9501b User ID
projectId required	string Example: projectId=123e4567-e89b-12d3-a456-426614174000 Auto-generated project ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"project": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Project",
"description": "This is my project"
}
}

Create new project

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectWithoutAutofield) Project object without auto-generated fields

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"name": "My Project",
"description": "This is my project"
}
}

Response samples

201
400
500

Content type

application/json

{"project": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Project",
"description": "This is my project"
}
}

Update project

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (Project) Project object

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Project",
"description": "This is my project"
}
}

Response samples

200
400
404
500

Content type

application/json

{"project": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Project",
"description": "This is my project"
}
}

Delete project

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
}
}

Response samples

400
404
500

Content type

application/json

{"message": "unexpected EOF",
"user": {"id": "user id is required, but got ''"
},
"project": {"id": "project id is required, but got ''"
}
}

Chapters

Get list of chapters for a project

query Parameters

userId required	string Example: userId=auth0\|65a3d656ca600978b0f9501b User ID
projectId required	string Example: projectId=123e4567-e89b-12d3-a456-426614174000 Auto-generated project ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"chapters": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Introduction",
"number": 1,
"sections": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Overview"
}
]
}
]
}

Create new Chapter

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID
required	object (ChapterWithoutAutofield) Chapter object without auto-generated fields

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"chapter": {"name": "Introduction",
"number": 1
}
}

Response samples

201
400
404
500

Content type

application/json

{"chapter": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Introduction",
"number": 1,
"sections": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Overview"
}
]
}
}

Update chapter

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID
required	object (Chapter) Chapter object

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"chapter": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Introduction",
"number": 1
}
}

Response samples

200
400
404
500

Content type

application/json

{"chapter": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Introduction",
"number": 1,
"sections": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Overview"
}
]
}
}

Delete chapter

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID
required	object (ChapterOnlyId) Chapter object with only ID

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"chapter": {"id": "123e4567-e89b-12d3-a456-426614174000"
}
}

Response samples

400
404
500

Content type

application/json

{"message": "unexpected EOF",
"user": {"id": "user id is required, but got ''"
},
"project": {"id": "project id is required, but got ''"
},
"chapter": {"id": "chapter id is required, but got ''"
}
}

Papers

Find paper

query Parameters

userId required	string Example: userId=auth0\|65a3d656ca600978b0f9501b User ID
projectId required	string Example: projectId=123e4567-e89b-12d3-a456-426614174000 Auto-generated project ID
chapterId required	string Example: chapterId=123e4567-e89b-12d3-a456-426614174000 Auto-generated chapter ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"paper": {"id": "123e4567-e89b-12d3-a456-426614174000",
"content": "## Introduction\nThis is the introduction of the paper.\n\n## What is note apps?\nNote apps is a web application that allows users to create, read, update, and delete notes.\n"
}
}

Update paper

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID
required	object (Paper) Paper object

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"paper": {"id": "123e4567-e89b-12d3-a456-426614174000",
"content": "## Introduction\nThis is the introduction of the paper.\n\n## What is note apps?\nNote apps is a web application that allows users to create, read, update, and delete notes.\n"
}
}

Response samples

200
400
404
500

Content type

application/json

{"paper": {"id": "123e4567-e89b-12d3-a456-426614174000",
"content": "## Introduction\nThis is the introduction of the paper.\n\n## What is note apps?\nNote apps is a web application that allows users to create, read, update, and delete notes.\n"
}
}

Graphs

Find graph

query Parameters

userId required	string Example: userId=auth0\|65a3d656ca600978b0f9501b User ID
projectId required	string Example: projectId=123e4567-e89b-12d3-a456-426614174000 Auto-generated project ID
chapterId required	string Example: chapterId=123e4567-e89b-12d3-a456-426614174000 Auto-generated chapter ID
sectionId required	string Example: sectionId=123e4567-e89b-12d3-a456-426614174000 Auto-generated section ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"graph": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Overview",
"paragraph": "## Introduction\nThis is the introduction of the paper.\n",
"children": [{"name": "Study of Note Apps",
"relation": "part of",
"description": "This is a part of the overview section.",
"children": [{ }
]
}
]
}
}

Update graph

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID
required	object (ChapterOnlyId) Chapter object with only ID
required	object (GraphContent) Graph object with only content fields

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"chapter": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"graph": {"id": "123e4567-e89b-12d3-a456-426614174000",
"paragraph": "## Introduction\nThis is the introduction of the paper.\n",
"children": [{"name": "Study of Note Apps",
"relation": "part of",
"description": "This is a part of the overview section.",
"children": [{ }
]
}
]
}
}

Response samples

200
400
404
500

Content type

application/json

{"graph": {"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Overview",
"paragraph": "## Introduction\nThis is the introduction of the paper.\n",
"children": [{"name": "Study of Note Apps",
"relation": "part of",
"description": "This is a part of the overview section.",
"children": [{ }
]
}
]
}
}

Delete graph

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID
required	object (ChapterOnlyId) Chapter object with only ID
required	object (SectionOnlyId) Section object with only ID

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"chapter": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"section": {"id": "123e4567-e89b-12d3-a456-426614174000"
}
}

Response samples

400
404
500

Content type

application/json

{"message": "unexpected EOF",
"user": {"id": "user id is required, but got ''"
},
"project": {"id": "project id is required, but got ''"
},
"chapter": {"id": "chapter id is required, but got ''"
},
"section": {"id": "section id is required, but got ''"
}
}

Sectionalize into graphs

Request Body schema: application/json

required	object (UserOnlyId) User object with only ID
required	object (ProjectOnlyId) Project object with only ID
required	object (ChapterOnlyId) Chapter object with only ID
required	Array of objects (SectionWithoutAutofield) <= 20 items

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "auth0|65a3d656ca600978b0f9501b"
},
"project": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"chapter": {"id": "123e4567-e89b-12d3-a456-426614174000"
},
"sections": [{"name": "Overview",
"content": "## Introduction\nThis is the introduction of the paper.\n"
}
]
}

Response samples

200
400
404
500

Content type

application/json

{"graphs": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Overview",
"paragraph": "## Introduction\nThis is the introduction of the paper.\n",
"children": [{"name": "Study of Note Apps",
"relation": "part of",
"description": "This is a part of the overview section.",
"children": [{ }
]
}
]
}
]
}