coop-cloud-chaos-patchs/outline
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

chore: API Consistency (#1304)

Browse Source 
* chore: Addressing API inconsistencies

* lint

* add: Missing sort to groups.list
fix: Documention issues

* test: fix

* feat: Add missing shares.info endpoint

* feat: Add sorting to users.list endpoint

* fix: Incorrect pagination parameters listed on user endpoints

* users.s3Upload -> attachments.create

* chore: exportAll -> export_all
This commit is contained in:
Tom Moor
2020-06-16 20:56:17 -07:00
committed by GitHub
parent 5010b08e83
commit 0f8d503df8
20 changed files with 309 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
server/pages/developers/Api.js
View File

@ -49,7 +49,7 @@ export default function Api() {
</Arguments>
</Method>
<Method method="users.s3Upload" label="Get S3 upload credentials">
<Method method="attachments.create" label="Get S3 upload credentials">
<Description>
You can upload small files and images as part of your documents.
All files are stored using Amazon S3. Instead of uploading files
@ -84,7 +84,7 @@ export default function Api() {
Promote a user to be a team admin. This endpoint is only available
for admin users.
</Description>
<Arguments pagination>
<Arguments>
<Argument id="id" description="User ID to be promoted" required />
</Arguments>
</Method>
@ -95,7 +95,7 @@ export default function Api() {
is always required. This endpoint is only available for admin
users.
</Description>
<Arguments pagination>
<Arguments>
<Argument id="id" description="User ID to be demoted" required />
</Arguments>
</Method>
@ -105,7 +105,7 @@ export default function Api() {
Admin can suspend users to reduce the number of accounts on their
billing plan or prevent them from accessing documention.
</Description>
<Arguments pagination>
<Arguments>
<Argument
id="id"
description="User ID to be suspended"
@ -122,7 +122,7 @@ export default function Api() {
Admin can re-active a suspended user. This will update the billing
plan and re-enable their access to the documention.
</Description>
<Arguments pagination>
<Arguments>
<Argument
id="id"
description="User ID to be activated"
@ -173,7 +173,10 @@ export default function Api() {
</Arguments>
</Method>
<Method method="collections.exportAll" label="Export all collections">
<Method
method="collections.export_all"
label="Export all collections"
>
<Description>
Returns a zip file of all the collections or creates an async job
to send a zip file via email to the authenticated user. If
@ -527,20 +530,6 @@ export default function Api() {
</Arguments>
</Method>
<Method method="documents.info" label="Get a document">
<Description>
Get a document with its ID or URL identifier from user’s
collections.
</Description>
<Arguments>
<Argument
id="id"
description="Document ID or URI identifier"
required
/>
</Arguments>
</Method>
<Method
method="documents.restore"
label="Restore a previous revision"
@ -651,32 +640,21 @@ export default function Api() {
</Arguments>
</Method>
<Method
method="documents.revision"
label="Get revision for a document"
>
<Method method="revisions.info" label="Get revision for a document">
<Description>Return a specific revision of a document.</Description>
<Arguments>
<Argument
id="id"
description="Document ID or URI identifier"
required
/>
<Argument id="revisionId" description="Revision ID" required />
<Argument id="id" description="Revision ID" required />
</Arguments>
</Method>
<Method
method="documents.revisions"
label="Get revisions for a document"
>
<Method method="revisions.list" label="Get revisions for a document">
<Description>
Return revisions for a document. Upon each edit, a new revision is
stored.
</Description>
<Arguments pagination>
<Argument
id="id"
id="documentId"
description="Document ID or URI identifier"
required
/>
@ -688,7 +666,7 @@ export default function Api() {
This method allows you to create a new group to organize people in
the team.
</Description>
<Arguments pagination>
<Arguments>
<Argument
id="name"
description="The name of the group"
@ -702,7 +680,7 @@ export default function Api() {
This method allows you to update an existing group. At this time
the only field that can be edited is the name.
</Description>
<Arguments pagination>
<Arguments>
<Argument id="id" description="Group ID" required />
<Argument
id="name"