Bump version to 0.8 and update documentation

i-doit · Apr 16, 2019 · a0e4981 · a0e4981
1 parent 23435ea
commit a0e4981
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 27 deletions.
diff --git a/.env.dist b/.env.dist
@@ -1,17 +1,17 @@
 # URL to i-doit API:
-URL="https://demo.i-doit.com/src/jsonrpc.php"
+URL=https://demo.i-doit.com/src/jsonrpc.php
 
 # API key to select tenant:
-KEY="xxx"
+KEY=xxx
 
 # Login with user name:
-USERNAME="admin"
+USERNAME=admin
 
 # User's password:
-PASSWORD="admin"
+PASSWORD=admin
 
 # Enforce language:
-#LANGUAGE="en"
+#LANGUAGE=en
 
 # Disable security-related cURL options:
-#BYPASS_SECURE_CONNECTION="1"
+#BYPASS_SECURE_CONNECTION=1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ##  [Unreleased]
 
+_tbd_
+
+
+##  [0.8] – 2019-04-16
+
+It's spring time! 🌱
+
+To get the full experience, please update your i-doit to version >= 1.12.2 and API add-on to version >= 1.10.2.
+
 
 ### Added
 
@@ -187,7 +196,8 @@ Happy summer time ⛱️
 Initial release
 
 
-[Unreleased]: https://github.com/bheisig/i-doit-api-client-php/compare/0.7...HEAD
+[Unreleased]: https://github.com/bheisig/i-doit-api-client-php/compare/0.8...HEAD
+[0.8]: https://github.com/bheisig/i-doit-api-client-php/compare/0.7...0.8
 [0.7]: https://github.com/bheisig/i-doit-api-client-php/compare/0.6...0.7
 [0.6]: https://github.com/bheisig/i-doit-api-client-php/compare/0.5...0.6
 [0.5]: https://github.com/bheisig/i-doit-api-client-php/compare/0.4...0.5

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -51,7 +51,7 @@ Notice, that any of your contributions merged into this repository will be [lice
 Developers must meet some more requirements:
 
 *   See requirements mentioned in the [documentation](README.md)
-*   You need at least PHP 7.1 (7.2 is recommended), for example to run unit tests
+*   You need at least PHP 7.1 (7.3 is recommended), for example to run unit tests
 *   [Xdebug](https://xdebug.org/), needed for code coverage with phpunit
 *   [Composer](https://getcomposer.org/)
 *   [Git](https://git-scm.com/)

diff --git a/README.md b/README.md
@@ -40,9 +40,9 @@ What's new? Take a look at the [changelog](CHANGELOG.md).
 
 Meet these simple requirements before using the client:
 
-*   A running instance of i-doit, version 1.10.2 or higher
-*   i-doit API add-on, version 1.9.1 or higher
-*   PHP, version 5.6 or higher (7.2 is recommended)
+*   A running instance of i-doit, version 1.12.2 or higher
+*   i-doit API add-on, version 1.10.2 or higher
+*   PHP, version 5.6 or higher (7.3 is recommended)
 *   PHP modules `curl`, `date`, `json`, `openssl` and `zlib`
 
 
@@ -51,10 +51,10 @@ Meet these simple requirements before using the client:
 It is recommended to install this client via [Composer](https://getcomposer.org/). Change to your project's root directory and fetch the latest stable version:
 
 ~~~ {.bash}
-composer require "bheisig/idoitapi=>=0.7"
+composer require "bheisig/idoitapi=>=0.8"
 ~~~
 
-This installs version `0.7` or higher if available. Instead of sticking to a specific/minimum version you may switch to the current development branch by using `@DEV`:
+This installs version `0.8` or higher if available. Instead of sticking to a specific/minimum version you may switch to the current development branch by using `@DEV`:
 
 ~~~ {.bash}
 composer require "bheisig/idoitapi=@DEV"
@@ -176,23 +176,31 @@ For almost every case there is a remote procedure you may call to read from or m
 
 | Namespace                     | Remote Procedure Call (RPC)           | Class in API Client Library   | Method                                                    |
 | ----------------------------- | ------------------------------------- | ----------------------------- | --------------------------------------------------------- |
-| `idoit`                       | `idoit.version`                       | `Idoit`                       | `readVersion()`                                           |
-|                               | `idoit.search`                        |                               | `search()`                                                |
+| `idoit`                       | `idoit.addons`                        | `Idoit`                       | `getAddOns()`                                             |
 |                               | `idoit.constants`                     |                               | `readConstants()`                                         |
+|                               | `idoit.license`                       |                               | `getLicense()`                                            |
+|                               | `idoit.search`                        |                               | `search()`                                                |
+|                               | `idoit.version`                       |                               | `readVersion()`                                           |
 |                               | `idoit.login`                         | `API`                         | `login()`                                                 |
 |                               | `idoit.logout`                        |                               | `logout()`                                                |
 | `cmdb.object`                 | `cmdb.object.create`                  | `CMDBObject`                  | `create()`                                                |
 |                               | `cmdb.object.read`                    |                               | `read()`                                                  |
-|                               | `cmdb.object.update`                  |                               | `udpate()`                                                |
-|                               | `cmdb.object.delete`                  |                               | `archive()`, `delete()`, `purge()`                        |
+|                               | `cmdb.object.update`                  |                               | `update()`                                                |
+|                               | `cmdb.object.archive`                 |                               | `archive()`                                               |
+|                               | `cmdb.object.delete`                  |                               | `delete()`                                                |
+|                               | `cmdb.object.purge`                   |                               | `purge()`                                                 |
 | `cmdb.objects`                | `cmdb.objects.read`                   | `CMDBObjects`                 | `read()`                                                  |
 | `cmdb.category`               | `cmdb.category.create`                | `CMDBCategory`                | `create()`                                                |
 |                               | `cmdb.category.read`                  |                               | `read()`, `readOneByID()`, `readFirst()`                  |
 |                               | `cmdb.category.update`                |                               | `update()`                                                |
-|                               | `cmdb.category.delete`                |                               | `archive()`, `delete()`, `purge()`                        |
+|                               | `cmdb.category.save`                  |                               | `save()`                                                  |
+|                               | `cmdb.category.archive`               |                               | `archive()`                                               |
+|                               | `cmdb.category.delete`                |                               | `delete()`                                                |
+|                               | `cmdb.category.purge`                 |                               | `purge()`                                                 |
 | `cmdb.category_info`          | `cmdb.category_info.read`             | `CMDBCategoryInfo`            | `read()`                                                  |
 | `cmdb.dialog`                 | `cmdb.dialog.create`                  | `CMDBDialog`                  | `create()`                                                |
 |                               | `cmdb.dialog.read`                    |                               | `read()`                                                  |
+|                               | `cmdb.dialog.delete`                  |                               | `delete()`                                                |
 | `cmdb.impact`                 | `cmdb.impact.read`                    | `CMDBImpact`                  | `readByID()`, `readByConst()`                             |
 | `cmdb.location_tree`          | `cmdb.location_tree.read`             | `CMDBLocationTree`            | `read()`, `readRecursively()`                             |
 | `cmdb.logbook`                | `cmdb.logbook.create`                 | `CMDBLogbook`                 | `create()`                                                |
@@ -500,16 +508,16 @@ use bheisig\idoitapi\CMDBCategory;
 $api = new API([/* … */]);
 
 $category = new CMDBCategory($api);
-$entryID = $this->category->create(
+$entryID = $this->category->save(
     42,
     'C__CATG__IP',
     [
         'net' => 123,
-        'active' => false,
-        'primary' => false,
+        'active' => 1,
+        'primary' => 0,
         'net_type' => 1,
         'ipv4_assignment' => 2,
-        "ipv4_address" =>  '10.20.10.100',
+        'ipv4_address' =>  '10.20.10.100',
         'description' => 'API TEST'
     ]
 );
@@ -591,7 +599,7 @@ use bheisig\idoitapi\CMDBCategory;
 $api = new API([/* … */]);
 
 $category = new CMDBCategory($api);
-$category->update(
+$category->save(
     42,
     'C__CATG__GLOBAL',
     [
@@ -962,12 +970,14 @@ use bheisig\idoitapi\API;
 use bheisig\idoitapi\Idoit;
 
 $api = new API([/* … */]);
-
 $idoit = new Idoit($api);
+
 $version = $idoit->readVersion();
 $constants = $idoit->readConstants();
+$addOns = $idoit->getAddOns();
+$license = $idoit->getLicense();
 
-var_dump($constants);
+var_dump($version, $constants, $addOns, $license);
 ~~~
 
 
@@ -1048,6 +1058,7 @@ Please, report any issues to [our issue tracker](https://github.com/bheisig/i-do
 ##  Projects using this API client library
 
 *   [i-doit CLI Tool](https://github.com/bheisig/i-doit-cli) – "Access your CMDB on the command line interface"
+*   [i-doit Check_MK 2 add-on](https://www.i-doit.com/en/i-doit/add-ons/check-mk-add-on-2/) – "Share information between i-doit and Check_MK"
 
 Send pull requests to add yours.
 

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "bheisig/idoitapi",
-    "version": "0.8-dev",
+    "version": "0.8",
     "description": "Easy-to-use, but feature-rich client library for i-doit's JSON-RPC API",
     "type": "library",
     "keywords": ["i-doit", "cmdb", "it documentation", "api", "json-rpc"],
@@ -33,7 +33,7 @@
         "jakub-onderka/php-parallel-lint": "^1.0",
         "phploc/phploc": "^4.0",
         "phpmd/phpmd" : "@stable",
-        "phpstan/phpstan": "^0.11.3",
+        "phpstan/phpstan": "^0.11.5",
         "phpunit/phpunit": "^7",
         "povils/phpmnd": "^2",
         "sebastian/phpcpd": "^4.1.0",