{"id":16330023,"url":"https://github.com/luin/doclab","last_synced_at":"2025-05-15T09:14:37.100Z","repository":{"id":28078448,"uuid":"31575822","full_name":"luin/doclab","owner":"luin","description":"[WIP] An elegant, open-source and non-technical users friendly wiki-based system for collaborative.","archived":false,"fork":false,"pushed_at":"2020-08-09T08:11:22.000Z","size":797,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-17T10:15:37.436Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-03T02:43:52.000Z","updated_at":"2015-03-09T18:19:54.000Z","dependencies_parsed_at":"2022-09-04T09:01:01.785Z","dependency_job_id":null,"html_url":"https://github.com/luin/doclab","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luin%2Fdoclab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luin%2Fdoclab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luin%2Fdoclab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luin%2Fdoclab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luin","download_url":"https://codeload.github.com/luin/doclab/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254310517,"owners_count":22049470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T23:18:12.760Z","updated_at":"2025-05-15T09:14:37.076Z","avatar_url":"https://github.com/luin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Doclab\n=============\n\n![Build Status](https://travis-ci.org/luin/doclab.svg?branch=master)\n[![Code Climate](https://codeclimate.com/github/luin/doclab/badges/gpa.svg)](https://codeclimate.com/github/luin/doclab)\n[![Test Coverage](https://codeclimate.com/github/luin/doclab/badges/coverage.svg)](https://codeclimate.com/github/luin/doclab)\n[![Dependency Status](https://david-dm.org/luin/doclab.svg)](https://david-dm.org/luin/doclab)\n\nInstall\n-------\n\n    npm install doclab-api\n\nHTTP API\n-------\n\nThere are two methods available for authentication: HTTP Basic and session token. HTTP Basic authentication should only be used to request a new session token or when session token don't have enough permission to access(or update) the resource(i.e. changing user's password).\n\nTo auth a user using session token, set the custom header \"X-SESSION-TOKEN\" with the value of the token you have.\n\n### Sessions\n\n**POST** `/sessions`\n\nCreate a new session and get the token. You need to specify a ttl(measured in seconds).\n\n[Test](test/api/sessions/create_session.js)\n[Code](routes/sessions.js)\n\n### Users\n\n**GET** `/users/{userId|'me'}`\n\nGet the info of the user\n\n[Test](test/api/users/get_user.js)\n[Code](routes/users.js)\n\n**POST** `/users`\n\nCreate a new user\n\n[Test](test/api/users/create_user.js)\n[Code](routes/users.js)\n\n**PATCH** `/users/{userId|'me'}`\n\nUpdate the current user's info\n\n[Test](test/api/users/patch_user.js)\n[Code](routes/users.js)\n\n**PUT** `/users/{userId|'me'}/password`\n\nUpdate the current user's password\n\n[Test](test/api/users/update_password.js)\n[Code](routes/users.js)\n\n### Teams\n\n**GET** `/teams`\n\nGet all teams\n\n[Test](test/api/teams/get_teams.js)\n[Code](routes/teams.js)\n\n**POST** `/teams`\n\nCreate a new team\n\n[Test](test/api/teams/create_team.js)\n[Code](routes/teams.js)\n\n### Projects\n\n**POST** `/projects`\n\nCreate a new project\n\n[Test](test/api/projects/create_project.js)\n[Code](routes/projects.js)\n\n**GET** `/projects`\n\nGet all projects which the current user has access to\n\n[Test](test/api/projects/get_projects.js)\n[Code](routes/projects.js)\n\n**GET** `/projects/:projectId`\n\nGet the specified project info\n\n[Test](test/api/projects/get_project.js)\n[Code](routes/projects.js)\n\n**PATCH** `/projects/:projectId`\n\nUpdate a project\n\n[Test](test/api/projects/update_project.js)\n[Code](routes/projects.js)\n\n**POST** `/projects/:projectId/collections`\n\nCreate a collection\n\n[Test](test/api/projects/create_collection.js)\n[Code](routes/projects.js)\n\n**PUT** `/projects/:projectId/teams/:teamId`\n\nUpdate the permission of the team to the project\n\n[Test](test/api/projects/update_team_permission.js)\n[Code](routes/projects.js)\n\n### Collections\n\n**Get** `/collections/:collectionId`\n\nGet the specified collection info\n\n[Test](test/api/collections/get_collection.js)\n[Code](routes/collections.js)\n\n**Get** `/collections/:collectionId/dirs`\n\nGet the dirs of a collection\n\n[Test](test/api/collections/get_collection_dirs.js)\n[Code](routes/collections.js)\n\n**POST** `/collections/:collectionId/dirs/_move`\n\nMove the doc in the dirs\n\n[Test](test/api/collections/move_collection_dirs.js)\n[Code](routes/collections.js)\n\n**POST** `/collections/:collectionId/docs`\n\nCreate a doc\n\n[Test](test/api/collections/create_doc.js)\n[Code](routes/collections.js)\n\n**POST** `/collections/:collectionId/_move`\n\nMove a collection\n\n[Test](test/api/collections/move_collection.js)\n[Code](routes/collections.js)\n\n### Docs\n\n**GET** `/docs/:docUUID`\n\nGet the doc.You can use `?version=:version` to specified a version\n\n[Test](test/api/docs/get_doc.js)\n[Code](routes/docs.js)\n\nGET `/docs/:docUUID/versions`\n\nGet the versions of the doc\n\n[Test](test/api/docs/get_doc_versions.js)\n[Code](routes/docs.js)\n\n**PATCH** `/docs/:docUUID`\n\nUpdate the title or content of the doc\n\n[Test](test/api/docs/update_doc.js)\n[Code](routes/docs.js)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluin%2Fdoclab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluin%2Fdoclab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluin%2Fdoclab/lists"}