Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/i1i1/outline-openapi

Last synced: about 1 month ago
JSON representation
Host: GitHub
URL: https://github.com/i1i1/outline-openapi
Owner: i1i1
Created: 2024-04-21T11:25:30.000Z (8 months ago)
Default Branch: master
Last Pushed: 2024-04-21T11:25:41.000Z (8 months ago)
Last Synced: 2024-04-21T12:54:39.343Z (8 months ago)
Language: Python
Size: 196 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # openapi-client

```sh

$ openapi-generator-cli -- generate -i spec3.json -g python -o ./openapi

```

I've only changed name of the package in `pyproject.toml`

Spec taken from here: https://raw.githubusercontent.com/outline/openapi/3e0d51dc54c3ed30d2935cdb187d143f5ff78c29/spec3.json

# Introduction

The Outline API is structured in an RPC style. It enables you to

programatically interact with all aspects of Outline’s data – in fact, the

main application is built on exactly the same API.

The API structure is available as an

[openapi specification](https://github.com/outline/openapi) if that’s your

jam – it can be used to generate clients for most programming languages.

# Making requests

Outline’s API follows simple RPC style conventions where each API endpoint is

a method on `https://app.getoutline.com/api/method`. Both `GET` and `POST`

methods are supported but it’s recommended that you make all call using POST.

Only HTTPS is supported and all response payloads are JSON.

When making `POST` requests, request parameters are parsed depending on

Content-Type header. To make a call using JSON payload, you must pass

Content-Type: application/json header, here’s an example using CURL:

```

curl https://app.getoutline.com/api/documents.info \\

-X 'POST' \\

-H 'authorization: Bearer MY_API_KEY' \\

-H 'content-type: application/json' \\

-H 'accept: application/json' \\

-d '{\"id\": \"outline-api-NTpezNwhUP\"}'

```

Or, with JavaScript:

```javascript

const response = await fetch(\"https://app.getoutline.com/api/documents.info\", {

  method: \"POST\",

  headers: {

    Accept: \"application/json\",

    \"Content-Type\": \"application/json\",

    Authorization: \"Bearer MY_API_KEY\"

  }

})

const body = await response.json();

const document = body.data;

```

# Authentication

To access API endpoints, you must provide a valid API key. You can create new

API keys in your [account settings](https://app.getoutline.com/settings). Be

careful when handling your keys as they give access to all of your documents,

you should treat them like passwords and they should never be committed to

source control.

To authenticate with API, you can supply the API key as a header

(`Authorization: Bearer YOUR_API_KEY`) or as part of the payload using `token`

parameter. Header based authentication is highly recommended so that your keys

don’t accidentally leak into logs.

Some API endpoints allow unauthenticated requests for public resources and

they can be called without an API key.

# Errors

All successful API requests will be returned with a 200 or 201 status code

and `ok: true` in the response payload. If there’s an error while making the

request, the appropriate status code is returned with the error message:

```

{

  \"ok\": false,

  \"error\": \"Not Found\"

}

```

# Pagination

Most top-level API resources have support for \"list\" API methods. For instance,

you can list users, documents, and collections. These list methods share

common parameters, taking both `limit` and `offset`.

Responses will echo these parameters in the root `pagination` key, and also

include a `nextPath` key which can be used as a handy shortcut to fetch the

next page of results. For example:

```

{

  ok: true,

  status: 200,

  data: […],

  pagination: {

    limit: 25,

    offset: 0,

    nextPath: \"/api/documents.list?limit=25&offset=25\"

  }

}

```

# Policies

Most API resources have associated \"policies\", these objects describe the

current API keys authorized actions related to an individual resource. It

should be noted that the policy \"id\" is identical to the resource it is

related to, policies themselves do not have unique identifiers.

For most usecases of the API, policies can be safely ignored. Calling

unauthorized methods will result in the appropriate response code – these can

be used in an interface to adjust which elements are visible.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0

- Package version: 1.0.0

- Generator version: 7.4.0

- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage

### pip install

If the python package is hosted on a repository, you can install directly using:

```sh

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

```

(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:

```python

import openapi_client

```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh

python setup.py install --user

```

(or `sudo python setup.py install` to install the package for all users)

Then import the package:

```python

import openapi_client

```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import openapi_client

from openapi_client.rest import ApiException

from pprint import pprint

# Defining the host is optional and defaults to https://app.getoutline.com/api

# See configuration.py for a list of all supported configuration parameters.

configuration = openapi_client.Configuration(

    host = "https://app.getoutline.com/api"

)

# The client must configure the authentication and authorization parameters

# in accordance with the API server security policy.

# Examples for each auth method are provided below, use the example that

# satisfies your auth use case.

# Configure Bearer authorization (JWT): http

configuration = openapi_client.Configuration(

    access_token = os.environ["BEARER_TOKEN"]

)

# Enter a context with an instance of the API client

with openapi_client.ApiClient(configuration) as api_client:

    # Create an instance of the API class

    api_instance = openapi_client.AttachmentsApi(api_client)

    attachments_create_post_request = openapi_client.AttachmentsCreatePostRequest() # AttachmentsCreatePostRequest |  (optional)

    try:

        # Create an attachment

        api_response = api_instance.attachments_create_post(attachments_create_post_request=attachments_create_post_request)

        print("The response of AttachmentsApi->attachments_create_post:\n")

        pprint(api_response)

    except ApiException as e:

        print("Exception when calling AttachmentsApi->attachments_create_post: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://app.getoutline.com/api*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*AttachmentsApi* | [**attachments_create_post**](docs/AttachmentsApi.md#attachments_create_post) | **POST** /attachments.create | Create an attachment

*AttachmentsApi* | [**attachments_delete_post**](docs/AttachmentsApi.md#attachments_delete_post) | **POST** /attachments.delete | Delete an attachment

*AttachmentsApi* | [**attachments_redirect_post**](docs/AttachmentsApi.md#attachments_redirect_post) | **POST** /attachments.redirect | Retrieve an attachment

*AuthApi* | [**auth_config_post**](docs/AuthApi.md#auth_config_post) | **POST** /auth.config | Retrieve auth config

*AuthApi* | [**auth_info_post**](docs/AuthApi.md#auth_info_post) | **POST** /auth.info | Retrieve auth

*CollectionsApi* | [**collections_add_group_post**](docs/CollectionsApi.md#collections_add_group_post) | **POST** /collections.add_group | Add a group to a collection

*CollectionsApi* | [**collections_add_user_post**](docs/CollectionsApi.md#collections_add_user_post) | **POST** /collections.add_user | Add a collection user

*CollectionsApi* | [**collections_create_post**](docs/CollectionsApi.md#collections_create_post) | **POST** /collections.create | Create a collection

*CollectionsApi* | [**collections_delete_post**](docs/CollectionsApi.md#collections_delete_post) | **POST** /collections.delete | Delete a collection

*CollectionsApi* | [**collections_documents_post**](docs/CollectionsApi.md#collections_documents_post) | **POST** /collections.documents | Retrieve a collections document structure

*CollectionsApi* | [**collections_export_all_post**](docs/CollectionsApi.md#collections_export_all_post) | **POST** /collections.export_all | Export all collections

*CollectionsApi* | [**collections_export_post**](docs/CollectionsApi.md#collections_export_post) | **POST** /collections.export | Export a collection

*CollectionsApi* | [**collections_group_memberships_post**](docs/CollectionsApi.md#collections_group_memberships_post) | **POST** /collections.group_memberships | List all collection group members

*CollectionsApi* | [**collections_info_post**](docs/CollectionsApi.md#collections_info_post) | **POST** /collections.info | Retrieve a collection

*CollectionsApi* | [**collections_list_post**](docs/CollectionsApi.md#collections_list_post) | **POST** /collections.list | List all collections

*CollectionsApi* | [**collections_memberships_post**](docs/CollectionsApi.md#collections_memberships_post) | **POST** /collections.memberships | List all collection memberships

*CollectionsApi* | [**collections_remove_group_post**](docs/CollectionsApi.md#collections_remove_group_post) | **POST** /collections.remove_group | Remove a collection group

*CollectionsApi* | [**collections_remove_user_post**](docs/CollectionsApi.md#collections_remove_user_post) | **POST** /collections.remove_user | Remove a collection user

*CollectionsApi* | [**collections_update_post**](docs/CollectionsApi.md#collections_update_post) | **POST** /collections.update | Update a collection

*CommentsApi* | [**comments_create_post**](docs/CommentsApi.md#comments_create_post) | **POST** /comments.create | Create a comment

*CommentsApi* | [**comments_delete_post**](docs/CommentsApi.md#comments_delete_post) | **POST** /comments.delete | Delete a comment

*CommentsApi* | [**comments_list_post**](docs/CommentsApi.md#comments_list_post) | **POST** /comments.list | List all comments

*CommentsApi* | [**comments_update_post**](docs/CommentsApi.md#comments_update_post) | **POST** /comments.update | Update a comment

*DocumentsApi* | [**documents_archive_post**](docs/DocumentsApi.md#documents_archive_post) | **POST** /documents.archive | Archive a document

*DocumentsApi* | [**documents_create_post**](docs/DocumentsApi.md#documents_create_post) | **POST** /documents.create | Create a document

*DocumentsApi* | [**documents_delete_post**](docs/DocumentsApi.md#documents_delete_post) | **POST** /documents.delete | Delete a document

*DocumentsApi* | [**documents_drafts_post**](docs/DocumentsApi.md#documents_drafts_post) | **POST** /documents.drafts | List all draft documents

*DocumentsApi* | [**documents_export_post**](docs/DocumentsApi.md#documents_export_post) | **POST** /documents.export | Export a document as markdown

*DocumentsApi* | [**documents_import_post**](docs/DocumentsApi.md#documents_import_post) | **POST** /documents.import | Import a file as a document

*DocumentsApi* | [**documents_info_post**](docs/DocumentsApi.md#documents_info_post) | **POST** /documents.info | Retrieve a document

*DocumentsApi* | [**documents_list_post**](docs/DocumentsApi.md#documents_list_post) | **POST** /documents.list | List all documents

*DocumentsApi* | [**documents_move_post**](docs/DocumentsApi.md#documents_move_post) | **POST** /documents.move | Move a document

*DocumentsApi* | [**documents_restore_post**](docs/DocumentsApi.md#documents_restore_post) | **POST** /documents.restore | Restore a document

*DocumentsApi* | [**documents_search_post**](docs/DocumentsApi.md#documents_search_post) | **POST** /documents.search | Search all documents

*DocumentsApi* | [**documents_star_post**](docs/DocumentsApi.md#documents_star_post) | **POST** /documents.star | Star a document

*DocumentsApi* | [**documents_templatize_post**](docs/DocumentsApi.md#documents_templatize_post) | **POST** /documents.templatize | Create a template from a document

*DocumentsApi* | [**documents_unpublish_post**](docs/DocumentsApi.md#documents_unpublish_post) | **POST** /documents.unpublish | Unpublish a document

*DocumentsApi* | [**documents_unstar_post**](docs/DocumentsApi.md#documents_unstar_post) | **POST** /documents.unstar | Unstar a document

*DocumentsApi* | [**documents_update_post**](docs/DocumentsApi.md#documents_update_post) | **POST** /documents.update | Update a document

*DocumentsApi* | [**documents_viewed_post**](docs/DocumentsApi.md#documents_viewed_post) | **POST** /documents.viewed | List all recently viewed documents

*EventsApi* | [**events_list_post**](docs/EventsApi.md#events_list_post) | **POST** /events.list | List all events

*FileOperationsApi* | [**file_operations_delete_post**](docs/FileOperationsApi.md#file_operations_delete_post) | **POST** /fileOperations.delete | Delete a file operation

*FileOperationsApi* | [**file_operations_info_post**](docs/FileOperationsApi.md#file_operations_info_post) | **POST** /fileOperations.info | Retrieve a file operation

*FileOperationsApi* | [**file_operations_list_post**](docs/FileOperationsApi.md#file_operations_list_post) | **POST** /fileOperations.list | List all file operations

*FileOperationsApi* | [**file_operations_redirect_post**](docs/FileOperationsApi.md#file_operations_redirect_post) | **POST** /fileOperations.redirect | Retrieve the file

*GroupsApi* | [**groups_add_user_post**](docs/GroupsApi.md#groups_add_user_post) | **POST** /groups.add_user | Add a group member

*GroupsApi* | [**groups_create_post**](docs/GroupsApi.md#groups_create_post) | **POST** /groups.create | Create a group

*GroupsApi* | [**groups_delete_post**](docs/GroupsApi.md#groups_delete_post) | **POST** /groups.delete | Delete a group

*GroupsApi* | [**groups_info_post**](docs/GroupsApi.md#groups_info_post) | **POST** /groups.info | Retrieve a group

*GroupsApi* | [**groups_list_post**](docs/GroupsApi.md#groups_list_post) | **POST** /groups.list | List all groups

*GroupsApi* | [**groups_memberships_post**](docs/GroupsApi.md#groups_memberships_post) | **POST** /groups.memberships | List all group members

*GroupsApi* | [**groups_remove_user_post**](docs/GroupsApi.md#groups_remove_user_post) | **POST** /groups.remove_user | Remove a group member

*GroupsApi* | [**groups_update_post**](docs/GroupsApi.md#groups_update_post) | **POST** /groups.update | Update a group

*RevisionsApi* | [**revisions_info_post**](docs/RevisionsApi.md#revisions_info_post) | **POST** /revisions.info | Retrieve a revision

*RevisionsApi* | [**revisions_list_post**](docs/RevisionsApi.md#revisions_list_post) | **POST** /revisions.list | List all revisions

*SharesApi* | [**shares_create_post**](docs/SharesApi.md#shares_create_post) | **POST** /shares.create | Create a share

*SharesApi* | [**shares_info_post**](docs/SharesApi.md#shares_info_post) | **POST** /shares.info | Retrieve a share object

*SharesApi* | [**shares_list_post**](docs/SharesApi.md#shares_list_post) | **POST** /shares.list | List all shares

*SharesApi* | [**shares_revoke_post**](docs/SharesApi.md#shares_revoke_post) | **POST** /shares.revoke | Revoke a share

*SharesApi* | [**shares_update_post**](docs/SharesApi.md#shares_update_post) | **POST** /shares.update | Update a share

*UsersApi* | [**users_activate_post**](docs/UsersApi.md#users_activate_post) | **POST** /users.activate | Activate a user

*UsersApi* | [**users_delete_post**](docs/UsersApi.md#users_delete_post) | **POST** /users.delete | Delete a user

*UsersApi* | [**users_info_post**](docs/UsersApi.md#users_info_post) | **POST** /users.info | Retrieve a user

*UsersApi* | [**users_invite_post**](docs/UsersApi.md#users_invite_post) | **POST** /users.invite | Invite users

*UsersApi* | [**users_list_post**](docs/UsersApi.md#users_list_post) | **POST** /users.list | List all users

*UsersApi* | [**users_suspend_post**](docs/UsersApi.md#users_suspend_post) | **POST** /users.suspend | Suspend a user

*UsersApi* | [**users_update_post**](docs/UsersApi.md#users_update_post) | **POST** /users.update | Update a user

*UsersApi* | [**users_update_role_post**](docs/UsersApi.md#users_update_role_post) | **POST** /users.update_role | Change a users role

*ViewsApi* | [**views_create_post**](docs/ViewsApi.md#views_create_post) | **POST** /views.create | Create a view

*ViewsApi* | [**views_list_post**](docs/ViewsApi.md#views_list_post) | **POST** /views.list | List all views

## Documentation For Models

 - [Attachment](docs/Attachment.md)

 - [AttachmentsCreatePost200Response](docs/AttachmentsCreatePost200Response.md)

 - [AttachmentsCreatePost200ResponseData](docs/AttachmentsCreatePost200ResponseData.md)

 - [AttachmentsCreatePostRequest](docs/AttachmentsCreatePostRequest.md)

 - [AttachmentsDeletePost200Response](docs/AttachmentsDeletePost200Response.md)

 - [AttachmentsRedirectPostRequest](docs/AttachmentsRedirectPostRequest.md)

 - [Auth](docs/Auth.md)

 - [AuthConfigPost200Response](docs/AuthConfigPost200Response.md)

 - [AuthConfigPost200ResponseData](docs/AuthConfigPost200ResponseData.md)

 - [AuthConfigPost200ResponseDataServicesInner](docs/AuthConfigPost200ResponseDataServicesInner.md)

 - [AuthInfoPost200Response](docs/AuthInfoPost200Response.md)

 - [Collection](docs/Collection.md)

 - [CollectionGroupMembership](docs/CollectionGroupMembership.md)

 - [CollectionSort](docs/CollectionSort.md)

 - [CollectionsAddGroupPost200Response](docs/CollectionsAddGroupPost200Response.md)

 - [CollectionsAddGroupPost200ResponseData](docs/CollectionsAddGroupPost200ResponseData.md)

 - [CollectionsAddGroupPostRequest](docs/CollectionsAddGroupPostRequest.md)

 - [CollectionsAddUserPost200Response](docs/CollectionsAddUserPost200Response.md)

 - [CollectionsAddUserPost200ResponseData](docs/CollectionsAddUserPost200ResponseData.md)

 - [CollectionsAddUserPostRequest](docs/CollectionsAddUserPostRequest.md)

 - [CollectionsCreatePost200Response](docs/CollectionsCreatePost200Response.md)

 - [CollectionsCreatePostRequest](docs/CollectionsCreatePostRequest.md)

 - [CollectionsDeletePostRequest](docs/CollectionsDeletePostRequest.md)

 - [CollectionsDocumentsPost200Response](docs/CollectionsDocumentsPost200Response.md)

 - [CollectionsExportAllPostRequest](docs/CollectionsExportAllPostRequest.md)

 - [CollectionsExportPost200Response](docs/CollectionsExportPost200Response.md)

 - [CollectionsExportPost200ResponseData](docs/CollectionsExportPost200ResponseData.md)

 - [CollectionsExportPostRequest](docs/CollectionsExportPostRequest.md)

 - [CollectionsGroupMembershipsPost200Response](docs/CollectionsGroupMembershipsPost200Response.md)

 - [CollectionsGroupMembershipsPost200ResponseData](docs/CollectionsGroupMembershipsPost200ResponseData.md)

 - [CollectionsGroupMembershipsPostRequest](docs/CollectionsGroupMembershipsPostRequest.md)

 - [CollectionsInfoPost200Response](docs/CollectionsInfoPost200Response.md)

 - [CollectionsInfoPostRequest](docs/CollectionsInfoPostRequest.md)

 - [CollectionsListPost200Response](docs/CollectionsListPost200Response.md)

 - [CollectionsMembershipsPost200Response](docs/CollectionsMembershipsPost200Response.md)

 - [CollectionsMembershipsPostRequest](docs/CollectionsMembershipsPostRequest.md)

 - [CollectionsRemoveGroupPostRequest](docs/CollectionsRemoveGroupPostRequest.md)

 - [CollectionsRemoveUserPostRequest](docs/CollectionsRemoveUserPostRequest.md)

 - [CollectionsUpdatePostRequest](docs/CollectionsUpdatePostRequest.md)

 - [Comment](docs/Comment.md)

 - [CommentsCreatePost200Response](docs/CommentsCreatePost200Response.md)

 - [CommentsCreatePostRequest](docs/CommentsCreatePostRequest.md)

 - [CommentsListPost200Response](docs/CommentsListPost200Response.md)

 - [CommentsListPostRequest](docs/CommentsListPostRequest.md)

 - [CommentsUpdatePostRequest](docs/CommentsUpdatePostRequest.md)

 - [Document](docs/Document.md)

 - [DocumentsCreatePost200Response](docs/DocumentsCreatePost200Response.md)

 - [DocumentsCreatePostRequest](docs/DocumentsCreatePostRequest.md)

 - [DocumentsDeletePostRequest](docs/DocumentsDeletePostRequest.md)

 - [DocumentsDraftsPostRequest](docs/DocumentsDraftsPostRequest.md)

 - [DocumentsExportPost200Response](docs/DocumentsExportPost200Response.md)

 - [DocumentsExportPostRequest](docs/DocumentsExportPostRequest.md)

 - [DocumentsInfoPost200Response](docs/DocumentsInfoPost200Response.md)

 - [DocumentsInfoPostRequest](docs/DocumentsInfoPostRequest.md)

 - [DocumentsListPostRequest](docs/DocumentsListPostRequest.md)

 - [DocumentsMovePost200Response](docs/DocumentsMovePost200Response.md)

 - [DocumentsMovePost200ResponseData](docs/DocumentsMovePost200ResponseData.md)

 - [DocumentsMovePostRequest](docs/DocumentsMovePostRequest.md)

 - [DocumentsRestorePostRequest](docs/DocumentsRestorePostRequest.md)

 - [DocumentsSearchPost200Response](docs/DocumentsSearchPost200Response.md)

 - [DocumentsSearchPost200ResponseDataInner](docs/DocumentsSearchPost200ResponseDataInner.md)

 - [DocumentsSearchPostRequest](docs/DocumentsSearchPostRequest.md)

 - [DocumentsStarPost200Response](docs/DocumentsStarPost200Response.md)

 - [DocumentsStarPostRequest](docs/DocumentsStarPostRequest.md)

 - [DocumentsUpdatePostRequest](docs/DocumentsUpdatePostRequest.md)

 - [DocumentsViewedPostRequest](docs/DocumentsViewedPostRequest.md)

 - [Error](docs/Error.md)

 - [Event](docs/Event.md)

 - [EventsListPost200Response](docs/EventsListPost200Response.md)

 - [EventsListPostRequest](docs/EventsListPostRequest.md)

 - [FileOperation](docs/FileOperation.md)

 - [FileOperationCollection](docs/FileOperationCollection.md)

 - [FileOperationsInfoPost200Response](docs/FileOperationsInfoPost200Response.md)

 - [FileOperationsInfoPostRequest](docs/FileOperationsInfoPostRequest.md)

 - [FileOperationsListPost200Response](docs/FileOperationsListPost200Response.md)

 - [FileOperationsListPostRequest](docs/FileOperationsListPostRequest.md)

 - [Group](docs/Group.md)

 - [GroupMembership](docs/GroupMembership.md)

 - [GroupsAddUserPost200Response](docs/GroupsAddUserPost200Response.md)

 - [GroupsAddUserPost200ResponseData](docs/GroupsAddUserPost200ResponseData.md)

 - [GroupsAddUserPostRequest](docs/GroupsAddUserPostRequest.md)

 - [GroupsCreatePost200Response](docs/GroupsCreatePost200Response.md)

 - [GroupsCreatePostRequest](docs/GroupsCreatePostRequest.md)

 - [GroupsInfoPost200Response](docs/GroupsInfoPost200Response.md)

 - [GroupsInfoPostRequest](docs/GroupsInfoPostRequest.md)

 - [GroupsListPost200Response](docs/GroupsListPost200Response.md)

 - [GroupsMembershipsPost200Response](docs/GroupsMembershipsPost200Response.md)

 - [GroupsMembershipsPost200ResponseData](docs/GroupsMembershipsPost200ResponseData.md)

 - [GroupsMembershipsPostRequest](docs/GroupsMembershipsPostRequest.md)

 - [GroupsRemoveUserPost200Response](docs/GroupsRemoveUserPost200Response.md)

 - [GroupsRemoveUserPost200ResponseData](docs/GroupsRemoveUserPost200ResponseData.md)

 - [GroupsUpdatePostRequest](docs/GroupsUpdatePostRequest.md)

 - [Invite](docs/Invite.md)

 - [Membership](docs/Membership.md)

 - [NavigationNode](docs/NavigationNode.md)

 - [Pagination](docs/Pagination.md)

 - [Permission](docs/Permission.md)

 - [Policy](docs/Policy.md)

 - [PolicyAbilities](docs/PolicyAbilities.md)

 - [Revision](docs/Revision.md)

 - [RevisionsInfoPost200Response](docs/RevisionsInfoPost200Response.md)

 - [RevisionsInfoPostRequest](docs/RevisionsInfoPostRequest.md)

 - [RevisionsListPost200Response](docs/RevisionsListPost200Response.md)

 - [Share](docs/Share.md)

 - [SharesCreatePostRequest](docs/SharesCreatePostRequest.md)

 - [SharesInfoPost200Response](docs/SharesInfoPost200Response.md)

 - [SharesInfoPostRequest](docs/SharesInfoPostRequest.md)

 - [SharesListPost200Response](docs/SharesListPost200Response.md)

 - [SharesUpdatePostRequest](docs/SharesUpdatePostRequest.md)

 - [Sorting](docs/Sorting.md)

 - [Team](docs/Team.md)

 - [User](docs/User.md)

 - [UserRole](docs/UserRole.md)

 - [UsersInfoPost200Response](docs/UsersInfoPost200Response.md)

 - [UsersInfoPostRequest](docs/UsersInfoPostRequest.md)

 - [UsersInvitePost200Response](docs/UsersInvitePost200Response.md)

 - [UsersInvitePostRequest](docs/UsersInvitePostRequest.md)

 - [UsersListPost200Response](docs/UsersListPost200Response.md)

 - [UsersListPostRequest](docs/UsersListPostRequest.md)

 - [UsersUpdatePostRequest](docs/UsersUpdatePostRequest.md)

 - [UsersUpdateRolePostRequest](docs/UsersUpdateRolePostRequest.md)

 - [View](docs/View.md)

 - [ViewsCreatePost200Response](docs/ViewsCreatePost200Response.md)

 - [ViewsListPost200Response](docs/ViewsListPost200Response.md)



## Documentation For Authorization

Authentication schemes defined for the API:



### http

- **Type**: Bearer authentication (JWT)

## Author

[email protected]