- First thing we build for Outline was its API. It's the heart and sole - of the service and as developers, it's our mission to make the API as - rich and easy to use as possible. + First thing we build for Outline was its API. It's the heart and sole of the service and + as developers, it's our mission to make the API as rich and easy to use as possible.
- While Outline is still in public beta, we might make small - adjustments, including breaking changes to the API. + While Outline is still in public beta, we might make small adjustments, including + breaking changes to the API.
- Outline's API follows simple RPC style conventions where each API
- endpoint is a method on{' '}
- https://www.getoutline.com/api/<METHOD>. Both{' '}
- GET and POST methods are supported but it's
- recommeded that you make all call using POST. Only HTTPS
- is supported in production.
+ Outline's API follows simple RPC style conventions where each API endpoint is a method on{' '}
+ https://www.getoutline.com/api/<METHOD>. Both GET and{' '}
+ POST methods are supported but it's recommeded that you make all call using{' '}
+ POST. Only HTTPS is supported in production.
- For GET requests query string parameters are expected
- (e.g.
- /api/document.info?id=...&token=...). When making{' '}
- POST requests, request parameters are parsed depending on{' '}
- Content-Type header. To make a call using JSON payload,
- one must pass Content-Type: application/json header:
+ For GET requests query string parameters are expected (e.g.
+ /api/document.info?id=...&token=...). When making POST requests,
+ request parameters are parsed depending on Content-Type header. To make a
+ call using JSON payload, one must pass Content-Type: application/json header:
@@ -72,33 +66,30 @@ curl https://www.getoutline.com/api/documents.info?id=outline-api-NTpezNwhUP&tok
- To access private API endpoints, you must provide a valid API key. You - can create new API keys in your{' '} - account settings. Be - careful when handling your keys as they give access to all of your - documents. + To access private API endpoints, you must provide a valid API key. You can create new API + keys in your account settings. Be careful when + handling your keys as they give access to all of your documents.
- To authenticate with Outline API, you can supply the API key as a
- header (Authorization: Bearer YOUR_API_KEY) or as part of
- the payload using token parameter. If you're making{' '}
- GET requests, header based authentication is recommended
- so that your keys don't leak into logs.
+ To authenticate with Outline API, you can supply the API key as a header (
+ Authorization: Bearer YOUR_API_KEY
+ ) or as part of the payload using token parameter. If you're making{' '}
+ GET requests, header based authentication is recommended so that your keys
+ don't leak into logs.
- Some API endpoints allow unauhenticated requests for public resources - and they can be called without an API key. + Some API endpoints allow unauhenticated requests for public resources and they can be + called without an API key.
- All successful API requests will be returned with 200{' '}
- status code and ok: true in the response payload. If
- there's an error while making the request, appropriate status code is
- returned with the error message:
+ All successful API requests will be returned with 200 status code and{' '}
+ ok: true in the response payload. If there's an error while making the
+ request, appropriate status code is returned with the error message:
@@ -125,46 +116,100 @@ curl https://www.getoutline.com/api/documents.info?id=outline-api-NTpezNwhUP&tok
- You can upload small files and images as part of your documents. All
- files are stored using Amazon S3. Instead of uploading files to
- Outline, you need to upload them directly to S3 with special
- credentials which can be obtained through this endpoint.
+ You can upload small files and images as part of your documents. All files are stored
+ using Amazon S3. Instead of uploading files to Outline, you need to upload them directly
+ to S3 with special credentials which can be obtained through this endpoint.
-
-
+
List all your document collections.
-
- Returns detailed information on a document collection.
-
+ Returns detailed information on a document collection.
+
+
+ Creates a new document collection.
+
+
+
+
+
+
+
+ This method returns information for a document with a specific ID. Following
+ identifiers are allowed:
+
+
+ - UUID - `id` field of the document
+ -
+ URI identifier - Human readable identifier used in Outline URLs (e.g.{' '}
+
outline-api-i48ZEZc5zjXndcP)
+
+
+
+
+
+
+
+
+
+ This methods allows you to search all of your documents with keywords.
+
+
+
+
+
+
+
+ This method allows you to publish a new document under an existing collection. By
+ default a document is set to the parent collection root. If you want to create a
+ subdocument, you can pass parentDocument to set parent document.
+
+
+
+ ID of the collection to which the document is created
+
+ }
+ required
+ />
+
+ ID of the parent document within the collection
+
+ }
+ />
+
+
+
+
+ Delete a document and all of its child documents if any.
+
+
+
{props.children}
-); +const Description = (props: { children: React.Element<*> }) =>{props.children}
; const Arguments = (props: { children: React.Element<*> }) => (