104 lines
7.5 KiB
TypeScript
104 lines
7.5 KiB
TypeScript
/* tslint:disable */
|
||
/* eslint-disable */
|
||
/**
|
||
* Outline API
|
||
* # 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 `POST` method on `https://app.getoutline.com/api/:method`. 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 ## API key You can create new API keys under **Settings => API & Apps**. 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 should supply the API key as the `Authorization` header (`Authorization: Bearer YOUR_API_KEY`). ## OAuth 2.0 OAuth 2.0 is a widely used protocol for authorization and authentication. It allows users to grant third-party _or_ internal applications access to their resources without sharing their credentials. To use OAuth 2.0 you need to follow these steps: 1. Register your application under **Settings => Applications** 2. Obtain an access token by exchanging the client credentials for an access token 3. Use the access token to authenticate requests to the API Some API endpoints allow unauthenticated requests for public resources and they can be called without authentication # Scopes Scopes are used to limit the access of an API key or application to specific resources. For example, an application may only need access to read documents, but not write them. Scopes can be global in the case of `read` and `write` scopes, specific to an API endpoint like `documents.read` and `documents.create`, or use wildcard scopes like `documents.*`. Some examples of scopes that can be used are: - `documents.read`: Allows reading documents - `documents.write`: Allows writing documents - `documents.*`: Allows all document-related actions - `users.*`: Allows all user-related actions - `read`: Allows all read actions - `write`: Allows all write actions # 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\" } } ``` # Rate limits Like most APIs, Outline has rate limits in place to prevent abuse. Endpoints that mutate data are more restrictive than read-only endpoints. If you exceed the rate limit for a given endpoint, you will receive a `429 Too Many Requests` status code. The response will include a `Retry-After` header that indicates how many seconds you should wait before making another request. # Policies Most API resources have associated \"policies\", these objects describe the current authentications 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.
|
||
*
|
||
* The version of the OpenAPI document: 0.1.0
|
||
* Contact: hello@getoutline.com
|
||
*
|
||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||
* https://openapi-generator.tech
|
||
* Do not edit the class manually.
|
||
*/
|
||
|
||
import { mapValues } from '../runtime';
|
||
import type { Policy } from './Policy';
|
||
import {
|
||
PolicyFromJSON,
|
||
PolicyFromJSONTyped,
|
||
PolicyToJSON,
|
||
PolicyToJSONTyped,
|
||
} from './Policy';
|
||
import type { Pagination } from './Pagination';
|
||
import {
|
||
PaginationFromJSON,
|
||
PaginationFromJSONTyped,
|
||
PaginationToJSON,
|
||
PaginationToJSONTyped,
|
||
} from './Pagination';
|
||
import type { Share } from './Share';
|
||
import {
|
||
ShareFromJSON,
|
||
ShareFromJSONTyped,
|
||
ShareToJSON,
|
||
ShareToJSONTyped,
|
||
} from './Share';
|
||
|
||
/**
|
||
*
|
||
* @export
|
||
* @interface SharesList200Response
|
||
*/
|
||
export interface SharesList200Response {
|
||
/**
|
||
*
|
||
* @type {Array<Share>}
|
||
* @memberof SharesList200Response
|
||
*/
|
||
data?: Array<Share>;
|
||
/**
|
||
*
|
||
* @type {Array<Policy>}
|
||
* @memberof SharesList200Response
|
||
*/
|
||
policies?: Array<Policy>;
|
||
/**
|
||
*
|
||
* @type {Pagination}
|
||
* @memberof SharesList200Response
|
||
*/
|
||
pagination?: Pagination;
|
||
}
|
||
|
||
/**
|
||
* Check if a given object implements the SharesList200Response interface.
|
||
*/
|
||
export function instanceOfSharesList200Response(value: object): value is SharesList200Response {
|
||
return true;
|
||
}
|
||
|
||
export function SharesList200ResponseFromJSON(json: any): SharesList200Response {
|
||
return SharesList200ResponseFromJSONTyped(json, false);
|
||
}
|
||
|
||
export function SharesList200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SharesList200Response {
|
||
if (json == null) {
|
||
return json;
|
||
}
|
||
return {
|
||
|
||
'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(ShareFromJSON)),
|
||
'policies': json['policies'] == null ? undefined : ((json['policies'] as Array<any>).map(PolicyFromJSON)),
|
||
'pagination': json['pagination'] == null ? undefined : PaginationFromJSON(json['pagination']),
|
||
};
|
||
}
|
||
|
||
export function SharesList200ResponseToJSON(json: any): SharesList200Response {
|
||
return SharesList200ResponseToJSONTyped(json, false);
|
||
}
|
||
|
||
export function SharesList200ResponseToJSONTyped(value?: SharesList200Response | null, ignoreDiscriminator: boolean = false): any {
|
||
if (value == null) {
|
||
return value;
|
||
}
|
||
|
||
return {
|
||
|
||
'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(ShareToJSON)),
|
||
'policies': value['policies'] == null ? undefined : ((value['policies'] as Array<any>).map(PolicyToJSON)),
|
||
'pagination': PaginationToJSON(value['pagination']),
|
||
};
|
||
}
|
||
|