sdkgen.lock

{"typehub/sdk":{"baseUrl":"https://api.typehub.cloud/","security":{"type":"oauth2","tokenUrl":"https://api.typehub.cloud/authorization/token","scopes":["commit","default","document","explore","issue","pull_request","star","tag","trigger"]},"operations":{"authorization.getWhoami":{"path":"/authorization/whoami","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"Backend_User"}},"arguments":[],"throws":[{"code":999,"schema":{"type":"reference","target":"Common_Message"}}],"description":"","stability":2,"security":["authorization"],"authorization":true,"tags":["authorization"]},"authorization.revoke":{"path":"/authorization/revoke","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Common_Message"}},"arguments":[],"throws":[{"code":999,"schema":{"type":"reference","target":"Common_Message"}}],"description":"","stability":2,"security":["authorization"],"authorization":true,"tags":["authorization"]},"commit.get":{"path":"/document/:user/:document/commit/:id","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"Commit"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns a commit","stability":1,"security":[],"authorization":false,"tags":["commit"]},"commit.getAll":{"path":"/document/:user/:document/commit","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"CommitCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns all commits for a document","stability":1,"security":[],"authorization":false,"tags":["commit"]},"document.create":{"path":"/document/:user","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"DocumentCreate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Creates a new document","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.delete":{"path":"/document/:user/:document","method":"DELETE","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Removes a document","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.export":{"path":"/document/:user/:document/export","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"DocumentExportResponse"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"DocumentExportRequest"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Export this document","stability":1,"security":[],"authorization":false,"tags":["document"]},"document.fork":{"path":"/document/:user/:document/fork","method":"GET","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Fork this document","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.get":{"path":"/document/:user/:document","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"Document"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"version":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns a document","stability":1,"security":[],"authorization":false,"tags":["document"]},"document.getAll":{"path":"/document/:user","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"DocumentCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns all documents","stability":1,"security":[],"authorization":false,"tags":["document"]},"document.import":{"path":"/document/:user/:document/import","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Import a TypeAPI specification to this document","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.meta":{"path":"/document/:user/:document/meta","method":"PUT","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"DocumentMeta"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Updates the meta data of an document","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.reset":{"path":"/document/:user/:document/reset","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Resets your document to the latest source","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.revert":{"path":"/document/:user/:document/revert/:id","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Reverts your document to this commit","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.showPreview":{"path":"/document/:user/:document/preview","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"DocumentPreview"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"version":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns a document preview","stability":1,"security":[],"authorization":false,"tags":["document"]},"document.star":{"path":"/document/:user/:document/star","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Stars this document","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"document.update":{"path":"/document/:user/:document","method":"PUT","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"DocumentUpdate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Updates a document","stability":1,"security":["document"],"authorization":true,"tags":["document"]},"explore.getAll":{"path":"/explore","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"DocumentCollection"}},"arguments":{"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns trending documents","stability":1,"security":[],"authorization":false,"tags":["explore"]},"issue.create":{"path":"/document/:user/:document/issue","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"IssueCreate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Creates a new issue","stability":1,"security":["issue"],"authorization":true,"tags":["issue"]},"issue.createComment":{"path":"/document/:user/:document/issue/:id/comment","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"CommentCreate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Creates a new issue comment","stability":1,"security":["issue"],"authorization":true,"tags":["issue"]},"issue.delete":{"path":"/document/:user/:document/issue/:id","method":"DELETE","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Removes an issue","stability":1,"security":["issue"],"authorization":true,"tags":["issue"]},"issue.get":{"path":"/document/:user/:document/issue/:id","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"Issue"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns an issue","stability":1,"security":[],"authorization":false,"tags":["issue"]},"issue.getAll":{"path":"/document/:user/:document/issue","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"IssueCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"status":{"in":"query","schema":{"type":"integer"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns all issues","stability":1,"security":[],"authorization":false,"tags":["issue"]},"issue.getAllComments":{"path":"/document/:user/:document/issue/:id/comment","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"CommentCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Shows all issue comments","stability":1,"security":[],"authorization":false,"tags":["issue"]},"issue.reactComment":{"path":"/document/:user/:document/issue/:id/comment/:comment/:reaction","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"comment":{"in":"path","schema":{"type":"string"}},"reaction":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Reacts to a comment","stability":1,"security":["issue"],"authorization":true,"tags":["issue"]},"meta.getAbout":{"path":"/","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"System_About"}},"arguments":[],"throws":[{"code":999,"schema":{"type":"reference","target":"Common_Message"}}],"description":"","stability":2,"security":[],"authorization":false,"tags":[]},"pull_request.create":{"path":"/document/:user/:document/pull_request","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"PullRequestCreate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Creates a new pull request","stability":1,"security":["pull_request"],"authorization":true,"tags":["pull_request"]},"pull_request.createComment":{"path":"/document/:user/:document/pull_request/:id/comment","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"CommentCreate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Creates a new pull request comment","stability":1,"security":["pull_request"],"authorization":true,"tags":["pull_request"]},"pull_request.delete":{"path":"/document/:user/:document/pull_request/:id","method":"DELETE","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Removes a pull request","stability":1,"security":["pull_request"],"authorization":true,"tags":["pull_request"]},"pull_request.get":{"path":"/document/:user/:document/pull_request/:id","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"PullRequest"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns a pull request","stability":1,"security":[],"authorization":false,"tags":["pull_request"]},"pull_request.getAll":{"path":"/document/:user/:document/pull_request","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"PullRequestCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"status":{"in":"query","schema":{"type":"integer"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns all pull requests","stability":1,"security":[],"authorization":false,"tags":["pull_request"]},"pull_request.getAllComments":{"path":"/document/:user/:document/pull_request/:id/comment","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"CommentCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Shows all pull request comments","stability":1,"security":[],"authorization":false,"tags":["pull_request"]},"pull_request.reactComment":{"path":"/document/:user/:document/pull_request/:id/comment/:comment/:reaction","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"comment":{"in":"path","schema":{"type":"string"}},"reaction":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Reacts to a comment","stability":1,"security":["pull_request"],"authorization":true,"tags":["pull_request"]},"pull_request.update":{"path":"/document/:user/:document/pull_request/:id","method":"PUT","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Merges a pull request","stability":1,"security":["pull_request"],"authorization":true,"tags":["pull_request"]},"star.getAll":{"path":"/star","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"DocumentCollection"}},"arguments":{"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns all stared documents for the current user","stability":1,"security":["star"],"authorization":true,"tags":["star"]},"tag.changelog":{"path":"/document/:user/:document/changelog","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"TagChangelog"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Generates the changelog for the current release","stability":1,"security":["tag"],"authorization":true,"tags":["tag"]},"tag.create":{"path":"/document/:user/:document/tag","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Creates a new tag","stability":1,"security":["tag"],"authorization":true,"tags":["tag"]},"tag.delete":{"path":"/document/:user/:document/tag/:id","method":"DELETE","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Removes a tag","stability":1,"security":["tag"],"authorization":true,"tags":["tag"]},"tag.get":{"path":"/document/:user/:document/tag/:id","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"Tag"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns a tag","stability":1,"security":[],"authorization":false,"tags":["tag"]},"tag.getAll":{"path":"/document/:user/:document/tag","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"TagCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns all tags for a document","stability":1,"security":[],"authorization":false,"tags":["tag"]},"tag.trigger":{"path":"/document/:user/:document/tag/:id/trigger","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Triggers a tag","stability":1,"security":["tag"],"authorization":true,"tags":["tag"]},"trigger.create":{"path":"/document/:user/:document/trigger","method":"POST","return":{"code":201,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"TriggerCreate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Creates a new trigger","stability":1,"security":["trigger"],"authorization":true,"tags":["trigger"]},"trigger.delete":{"path":"/document/:user/:document/trigger/:id","method":"DELETE","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Removes a trigger","stability":1,"security":["trigger"],"authorization":true,"tags":["trigger"]},"trigger.execute":{"path":"/document/:user/:document/trigger/:id/execute","method":"POST","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"Passthru"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Executes a trigger","stability":1,"security":["trigger"],"authorization":true,"tags":["trigger"]},"trigger.get":{"path":"/document/:user/:document/trigger/:id","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"Trigger"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns a trigger","stability":1,"security":["trigger"],"authorization":true,"tags":["trigger"]},"trigger.getAll":{"path":"/document/:user/:document/trigger","method":"GET","return":{"code":200,"schema":{"type":"reference","target":"TriggerCollection"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"startIndex":{"in":"query","schema":{"type":"integer"}},"count":{"in":"query","schema":{"type":"integer"}},"search":{"in":"query","schema":{"type":"string"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Returns all configured triggers","stability":1,"security":["trigger"],"authorization":true,"tags":["trigger"]},"trigger.update":{"path":"/document/:user/:document/trigger/:id","method":"PUT","return":{"code":200,"schema":{"type":"reference","target":"Message"}},"arguments":{"user":{"in":"path","schema":{"type":"string"}},"document":{"in":"path","schema":{"type":"string"}},"id":{"in":"path","schema":{"type":"string"}},"payload":{"in":"body","schema":{"type":"reference","target":"TriggerUpdate"}}},"throws":[{"code":400,"schema":{"type":"reference","target":"Message"}},{"code":404,"schema":{"type":"reference","target":"Message"}},{"code":500,"schema":{"type":"reference","target":"Message"}}],"description":"Updates a trigger","stability":1,"security":["trigger"],"authorization":true,"tags":["trigger"]}},"definitions":{"Backend_App":{"type":"struct","properties":{"id":{"type":"integer"},"userId":{"type":"integer"},"status":{"type":"integer"},"name":{"type":"string"},"url":{"type":"string"},"parameters":{"type":"string"},"appKey":{"type":"string"},"appSecret":{"type":"string"},"metadata":{"type":"reference","target":"Common_Metadata"},"date":{"type":"string","format":"date-time"},"scopes":{"type":"array","schema":{"type":"string"}},"tokens":{"type":"array","schema":{"type":"reference","target":"Backend_Token"}}}},"Backend_Token":{"type":"struct","properties":{"id":{"type":"integer"},"status":{"type":"integer"},"name":{"type":"string"},"scopes":{"type":"array","schema":{"type":"string"}},"ip":{"type":"string"},"expire":{"type":"string","format":"date-time"},"date":{"type":"string","format":"date-time"}}},"Backend_User":{"type":"struct","properties":{"id":{"type":"integer"},"roleId":{"type":"integer"},"planId":{"type":"integer"},"status":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string"},"points":{"type":"integer"},"scopes":{"type":"array","schema":{"type":"string"}},"apps":{"type":"array","schema":{"type":"reference","target":"Backend_App"}},"metadata":{"type":"reference","target":"Common_Metadata"},"date":{"type":"string","format":"date-time"}}},"Collection":{"type":"struct","properties":{"totalResults":{"type":"integer"},"startIndex":{"type":"integer"},"itemsPerPage":{"type":"integer"},"entry":{"type":"array","schema":{"type":"generic","name":"T"}}}},"Comment":{"type":"struct","properties":{"id":{"type":"integer"},"user":{"type":"reference","target":"User"},"status":{"type":"integer"},"reaction":{"type":"reference","target":"CommentReactions"},"comment":{"type":"string"},"updateDate":{"type":"string","format":"date-time"},"insertDate":{"type":"string","format":"date-time"}}},"CommentCollection":{"type":"struct","parent":{"type":"reference","target":"Collection","template":{"T":"Comment"}}},"CommentCreate":{"type":"struct","parent":{"type":"reference","target":"Comment"}},"CommentReactions":{"type":"struct","properties":{"like":{"type":"integer"},"dislike":{"type":"integer"},"laugh":{"type":"integer"},"hooray":{"type":"integer"},"confused":{"type":"integer"},"heart":{"type":"integer"},"rocket":{"type":"integer"},"eyes":{"type":"integer"}}},"Commit":{"type":"struct","properties":{"id":{"type":"integer"},"document":{"type":"reference","target":"Document"},"user":{"type":"reference","target":"User"},"previous":{"type":"reference","target":"CommitPrevious"},"message":{"type":"string"},"commitHash":{"type":"string"},"spec":{"type":"any"},"insertDate":{"type":"string","format":"date-time"}}},"CommitCollection":{"type":"struct","parent":{"type":"reference","target":"Collection","template":{"T":"Commit"}}},"CommitPrevious":{"type":"struct","properties":{"id":{"type":"integer"},"message":{"type":"string"},"commitHash":{"type":"string"},"spec":{"type":"any"},"insertDate":{"type":"string","format":"date-time"}}},"Common_Message":{"description":"Common error message","type":"struct","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"id":{"type":"string"}}},"Common_Metadata":{"type":"map","schema":{"type":"string"}},"Document":{"type":"struct","properties":{"id":{"type":"integer"},"user":{"type":"reference","target":"User"},"source":{"type":"reference","target":"Document"},"status":{"type":"integer"},"stars":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"private":{"type":"boolean"},"baseVersion":{"type":"string"},"developmentMode":{"type":"boolean"},"homepage":{"type":"string"},"spec":{"type":"any"},"updateDate":{"type":"string","format":"date-time"},"insertDate":{"type":"string","format":"date-time"}}},"DocumentCollection":{"type":"struct","parent":{"type":"reference","target":"Collection","template":{"T":"Document"}}},"DocumentCreate":{"type":"struct","properties":{"name":{"type":"string"},"description":{"type":"string"},"private":{"type":"boolean"},"baseVersion":{"type":"string"},"homepage":{"type":"string"}}},"DocumentExportRequest":{"type":"struct","properties":{"version":{"type":"string"},"format":{"type":"string"},"namespace":{"type":"string"}}},"DocumentExportResponse":{"type":"struct","properties":{"href":{"type":"string"}}},"DocumentMeta":{"type":"struct","properties":{"description":{"type":"string"},"private":{"type":"boolean"},"baseVersion":{"type":"string"},"developmentMode":{"type":"boolean"},"homepage":{"type":"string"}}},"DocumentPreview":{"type":"struct","properties":{"tags":{"type":"array","schema":{"type":"reference","target":"Tag"}},"repositories":{"type":"array","schema":{"type":"reference","target":"DocumentRepository"}},"types":{"type":"array","schema":{"type":"string"}}}},"DocumentRepository":{"type":"struct","properties":{"name":{"type":"string"},"href":{"type":"string"}}},"DocumentUpdate":{"type":"struct","properties":{"spec":{"type":"any"}}},"Issue":{"type":"struct","properties":{"id":{"type":"integer"},"user":{"type":"reference","target":"User"},"document":{"type":"reference","target":"Document"},"status":{"type":"integer"},"title":{"type":"string"},"updateDate":{"type":"string","format":"date-time"},"insertDate":{"type":"string","format":"date-time"}}},"IssueCollection":{"type":"struct","parent":{"type":"reference","target":"Collection","template":{"T":"Issue"}}},"IssueCreate":{"type":"struct","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"Message":{"type":"struct","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"Passthru":{"description":"No schema information available","type":"map","schema":{"type":"any"}},"PullRequest":{"type":"struct","properties":{"id":{"type":"integer"},"status":{"type":"integer"},"source":{"type":"reference","target":"Document"},"target":{"type":"reference","target":"Document"},"user":{"type":"reference","target":"User"},"title":{"type":"string"},"updateDate":{"type":"string","format":"date-time"},"insertDate":{"type":"string","format":"date-time"}}},"PullRequestCollection":{"type":"struct","parent":{"type":"reference","target":"Collection","template":{"T":"PullRequest"}}},"PullRequestCreate":{"type":"struct","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"System_About":{"type":"struct","properties":{"apiVersion":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"termsOfService":{"type":"string"},"contactName":{"type":"string"},"contactUrl":{"type":"string"},"contactEmail":{"type":"string"},"licenseName":{"type":"string"},"licenseUrl":{"type":"string"},"paymentCurrency":{"type":"string"},"categories":{"type":"array","schema":{"type":"string"}},"scopes":{"type":"array","schema":{"type":"string"}},"apps":{"type":"reference","target":"System_AboutApps"},"links":{"type":"array","schema":{"type":"reference","target":"System_AboutLink"}}}},"System_AboutApps":{"type":"map","schema":{"type":"string"}},"System_AboutLink":{"type":"struct","properties":{"rel":{"type":"string"},"href":{"type":"string"}}},"Tag":{"type":"struct","properties":{"id":{"type":"string"},"document":{"type":"reference","target":"Document"},"user":{"type":"reference","target":"User"},"version":{"type":"string"},"changelog":{"type":"string"},"spec":{"type":"any"},"insertDate":{"type":"string","format":"date-time"}}},"TagChangelog":{"type":"struct","properties":{"master":{"type":"any"},"tag":{"type":"any"},"version":{"type":"string"},"changelog":{"type":"array","schema":{"type":"string"}}}},"TagCollection":{"type":"struct","parent":{"type":"reference","target":"Collection","template":{"T":"Tag"}}},"Trigger":{"type":"struct","properties":{"id":{"type":"integer"},"user":{"type":"reference","target":"User"},"document":{"type":"reference","target":"Document"},"type":{"type":"string"},"config":{"type":"reference","target":"TriggerConfig"},"updateDate":{"type":"string","format":"date-time"},"insertDate":{"type":"string","format":"date-time"}}},"TriggerCollection":{"type":"struct","parent":{"type":"reference","target":"Collection","template":{"T":"Trigger"}}},"TriggerConfig":{"type":"map","schema":{"type":"string"}},"TriggerCreate":{"type":"struct","parent":{"type":"reference","target":"Trigger"}},"TriggerUpdate":{"type":"struct","parent":{"type":"reference","target":"Trigger"}},"User":{"type":"struct","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}}