From 76a22e6e0e92eebbbb233de272cc12f585b74d00 Mon Sep 17 00:00:00 2001 From: Samuel Hassine Date: Thu, 5 Dec 2019 15:09:09 +0100 Subject: [PATCH] [documentation] First work on new version doc --- .../version-2.1.0/clients/python/guide.md | 8 ++++ .../version-2.1.0/clients/python/overview.md | 36 ++++++++++++++++ .../version-2.1.0/clients/python/reference.md | 8 ++++ .../version-2.1.0-sidebars.json | 41 +++++++++++++++++++ opencti-documentation/website/versions.json | 1 + 5 files changed, 94 insertions(+) create mode 100644 opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/guide.md create mode 100644 opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/overview.md create mode 100644 opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/reference.md create mode 100644 opencti-documentation/website/versioned_sidebars/version-2.1.0-sidebars.json diff --git a/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/guide.md b/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/guide.md new file mode 100644 index 000000000000..8af466b10027 --- /dev/null +++ b/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/guide.md @@ -0,0 +1,8 @@ +--- +id: version-2.1.0-guide +title: User's guide +sidebar_label: User's guide +original_id: guide +--- + +The Python lib \ No newline at end of file diff --git a/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/overview.md b/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/overview.md new file mode 100644 index 000000000000..63ecbe51666b --- /dev/null +++ b/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/overview.md @@ -0,0 +1,36 @@ +--- +id: version-2.1.0-overview +title: OpenCTI Python client +sidebar_label: Overview +original_id: overview +--- + +The `pycti` library is designed to help OpenCTI users and developers to programatically interact with the GraphQL API. It has been architectured to be easy to use and easy to maintain. The Python library requires Python >= 3. Let's get started. + +## Installation + +```bash +$ pip install pycti +``` + +## Getting started + +### Initialization + +The main class contains all what you need to interact with the platform, you just have to initialize it: + +```python +# coding: utf-8 + +from pycti import OpenCTIApiClient + +# OpenCTI initialization +opencti_api_client = OpenCTIApiClient(api_url, api_token, log_level, ssl_verify) +``` + +| Argument | Type | Description | +| ------------------------ | ------------------ | --------------------------------------------------------------------| +| api_url (*required*) | String | The URL of the OpenCTI instance | +| api_token (*required*) | String | The OpenCTI token | +| log_level (*optional*) | String | Log level, could be 'debug', 'info', 'warning' or 'error' | +| ssl_verify (*optional*) | Boolean | Enable or disable the SSL certificate verification | \ No newline at end of file diff --git a/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/reference.md b/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/reference.md new file mode 100644 index 000000000000..d8ff6ab91ae9 --- /dev/null +++ b/opencti-documentation/website/versioned_docs/version-2.1.0/clients/python/reference.md @@ -0,0 +1,8 @@ +--- +id: version-2.1.0-reference +title: API reference +sidebar_label: API reference +original_id: reference +--- + +The Python lib \ No newline at end of file diff --git a/opencti-documentation/website/versioned_sidebars/version-2.1.0-sidebars.json b/opencti-documentation/website/versioned_sidebars/version-2.1.0-sidebars.json new file mode 100644 index 000000000000..91464e16d02a --- /dev/null +++ b/opencti-documentation/website/versioned_sidebars/version-2.1.0-sidebars.json @@ -0,0 +1,41 @@ +{ + "version-2.1.0-docs": { + "Getting Started": [ + "version-2.1.0-getting-started/introduction", + "version-2.1.0-getting-started/architecture", + "version-2.1.0-getting-started/requirements" + ], + "Installation": [ + "version-2.1.0-installation/docker", + "version-2.1.0-installation/manual", + "version-2.1.0-installation/connectors", + "version-2.1.0-development/installation" + ], + "Usage": [ + "version-2.1.0-usage/overview", + "version-2.1.0-usage/model", + "version-2.1.0-usage/knowledge-create", + "version-2.1.0-usage/reports-create", + "version-2.1.0-usage/report-knowledge" + ], + "Reference": [ + "version-2.1.0-reference/relations", + "version-2.1.0-reference/inferences" + ], + "Development": [ + "version-2.1.0-development/connectors" + ], + "Client libraries": [ + "version-2.1.0-python", + { + "type": "subcategory", + "label": "Python", + "ids": [ + "version-2.1.0-clients/python/overview", + "version-2.1.0-clients/python/guide", + "version-2.1.0-clients/python/reference" + ] + } + ] + } +} diff --git a/opencti-documentation/website/versions.json b/opencti-documentation/website/versions.json index 8ffaf3b2b5b9..74b27f9744c0 100644 --- a/opencti-documentation/website/versions.json +++ b/opencti-documentation/website/versions.json @@ -1,4 +1,5 @@ [ + "2.1.0", "2.0.0", "1.1.2", "1.1.1",