@manyos/smileconnect-api 1.39.1 → 1.40.0

package/docs/howto/{worklog-attachment.md → attachments.md}

@@ -1,11 +1,4 @@
----
-layout: page
-title: Attachments
-subtitle: In this guide we'll show you how to save and read attachments from worklogs.
-use-site-title: true
-gh-badge: [star, fork, follow]
-gh-repo: daattali/beautiful-jekyll
----
+# Attachments
 
 In this guide we'll show you how to save and read attachments from worklogs.
 
@@ -14,7 +7,7 @@ In this guide we'll show you how to save and read attachments from worklogs.
 
 To store an attachment you first need to create a worklog. The worklog contains an attachment url:
 
-{% highlight json linenos %}
+```json
 {
     "data": {
         "summary": "Implementation update",
@@ -30,7 +23,7 @@ To store an attachment you first need to create a worklog. The worklog contains
         }
     ]
 }
-{% endhighlight %}
+```
 
 This URL will be used to upload or download the attachment.
 
@@ -70,11 +63,11 @@ Provide the attachment as application/x-www-form-urlencoded with the key "file".
 
 ### Sample Response
 
-POST:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000001240/attachment
+POST: https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000001240/attachment
 
-{% highlight json linenos %}
+```json
 "['WLG000000001240':'success']"
-{% endhighlight %}
+```
 
 ### Postman Sample Request / Response
 ![architecure of isapi](../img/attachment-upload.png)
@@ -108,6 +101,6 @@ Use your [API Token](token.md)
 
 ### Sample Response
 
-GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000000533/attachment
+GET: https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000000533/attachment
 
-The file will be returned as application/octet-stream. The filename will be returned in the header Content-disposition. e.g. attachment; filename=90502081_l.jpg
+The file will be returned as application/octet-stream. The filename will be returned in the header Content-disposition. e.g. attachment; filename=90502081_l.jpg

package/docs/howto/cmdbobjects.md

@@ -1,10 +1,4 @@
----
-layout: page
-title: Access CMDBObjects
-subtitle: In this guide you will learn to do the basic operations with an CMDB Objects.
-use-site-title: true
-gh-badge: [star, fork, follow]
-gh-repo: daattali/beautiful-jekyll
+CMDBObjects
 ---
 
 # Read a CMDBObject
@@ -31,13 +25,13 @@ To read a cmdbobject you need to do a GET request to the /v1/cmdbobjects/*id* en
 
 *Type*: Bearer
 
-Use your [API Token](token.md)
+Use your [API Token](howto/token.md)
 
 ### Sample Response
 
-GET:https://*api-fqdn*/v1/cmdbobjects/AGGarserver000PMIYWAPL1SMUB5AZ
+GET: https://*api-fqdn*/v1/cmdbobjects/AGGarserver000PMIYWAPL1SMUB5AZ
 
-{% highlight json linenos %}
+```json
 {
     "data": {
         "id": "AGGarserver000PMIYWAPL1SMUB5AZ",
@@ -265,7 +259,7 @@ GET:https://*api-fqdn*/v1/cmdbobjects/AGGarserver000PMIYWAPL1SMUB5AZ
        ]
    }
 }
-{% endhighlight %}
+```
 
 # Search for CMDBObjects
 
@@ -289,7 +283,7 @@ To search for objects do a POST to the /v1/cmdbobjects/search endpoint of your A
 
 *Type*: Bearer
 
-Use your [API Token](token.md)
+Use your [API Token](howto/token.md)
 
 ### Body
 
@@ -297,9 +291,9 @@ Provide the searchString you want to use
 
 ### Sample Request
 
-POST:https://*api-fqdn*/v1/cmdbobjects/search
+POST: https://*api-fqdn*/v1/cmdbobjects/search
 
-{% highlight json linenos %}
+```json
 {
 	"searchString":"'name' LIKE \"Computer%\"",
 	"getRelations":true,
@@ -315,11 +309,11 @@ POST:https://*api-fqdn*/v1/cmdbobjects/search
 	"limit": 100,
 	"offset": 4
 }
-{% endhighlight %}
+```
 
 ### Sample Response
 
-{% highlight json linenos %}
+```json
 {
     "data": [
         {
@@ -336,4 +330,4 @@ POST:https://*api-fqdn*/v1/cmdbobjects/search
     ],
     "included": {}
 }
-{% endhighlight %}
+```

package/docs/howto/incidents.md

@@ -1,13 +1,6 @@
----
-layout: page
-title: Incident handling
-subtitle: In this guide you will learn to do the basic operations with an incident.
-use-site-title: true
-gh-badge: [star, fork, follow]
-gh-repo: daattali/beautiful-jekyll
----
+# Incdent Requests
 
-In this guide we model the full lifecylce of a simple inbound API that delivers Incidents into your system. First we'll create one. We will then read it again and later resolve it. 
+In this guide we model the full lifecylce of a simple inbound API that delivers Incidents into your system. First we'll create one. We will then read it again and later resolve it.
 
 # Create an Incident
 
@@ -39,20 +32,20 @@ Provide all your needed incident data (see mapping -> new Incident) within the *
 
 ### Sample Request
 
-POST:https://*api-fqdn*/v1/incidents
+POST: https://*api-fqdn*/v1/incidents
 
-{% highlight json linenos %}
+```json
 {
     "data": {
         "summary": "New Incident",
         "detailedDescription": "Here are the details"
     }
 }
-{% endhighlight %}
+```
 
 ### Sample Response
 
-{% highlight json linenos %}
+```json
 {
     "data": {
         "id": "INC000000000217",
@@ -91,7 +84,7 @@ POST:https://*api-fqdn*/v1/incidents
         ]
     }
 }
-{% endhighlight %}
+```
 
 # Read an Incident
 
@@ -121,9 +114,9 @@ Use your [API Token](token.md)
 
 ### Sample Response
 
-GET:https://*api-fqdn*/v1/incidents/INC000000000217
+GET: https://*api-fqdn*/v1/incidents/INC000000000217
 
-{% highlight json linenos %}
+```
 {
     "data": {
         "id": "INC000000000217",
@@ -162,7 +155,7 @@ GET:https://*api-fqdn*/v1/incidents/INC000000000217
         ]
     }
 }
-{% endhighlight %}
+```
 
 # Update an Incident
 
@@ -196,21 +189,21 @@ Provide all the attributes you want to update.
 
 ### Sample Request
 
-PUT:https://*api-fqdn*/v1/incidents/INC000000000217
+PUT: https://*api-fqdn*/v1/incidents/INC000000000217
 
-{% highlight json linenos %}
+```json
 {
     "data": {
         "status": "Resolved",
-        "statusReason" : "No Further Action Required", 
+        "statusReason" : "No Further Action Required",
         "resolution": "Please restart your computer."
     }
 }
-{% endhighlight %}
+```
 
 ### Sample Response
 
-{% highlight json linenos %}
+```
 {
     "data": {
         "id": "INC000000000217",
@@ -241,4 +234,4 @@ PUT:https://*api-fqdn*/v1/incidents/INC000000000217
     },
     "included": {}
 }
-{% endhighlight %}
+```

package/docs/howto/token.md

@@ -1,16 +1,12 @@
----
-layout: page
-title: Authentication
-subtitle: How to get a token
----
+# Authentication
 
-Our API integrates with any OpenID Connect Server for authentication. If you use [Keycloak](https://www.keycloak.org/) as we do, here is how to get a token.
+Our API integrates with any OpenID Connect Server for authentication. If you use [Keycloak](https://www.keycloak.org/), as we do, here is how to get a token.
 
-## Request Definition
+# Request Definition
 
 To create a token you need to do a POST request to your SSO Server token url. Use Basic Authentication with your clientId and secret and sent grant_type=client_credentials as body.
 
-### URL
+## URL
 
 *URL*: https://*sso-fqdn*/auth/realms/*realm*/protocol/openid-connect/token
 
@@ -18,11 +14,11 @@ To create a token you need to do a POST request to your SSO Server token url. Us
 
 *realm*: Your security realm. e.G. isapi
 
-### Headers
+## Headers
 
 *Content-Type*: application/x-www-form-urlencoded
 
-### Authorization
+## Authorization
 
 *Type*: Basic Auth
 
@@ -30,15 +26,15 @@ To create a token you need to do a POST request to your SSO Server token url. Us
 
 *Password*: Your API Secret
 
-### Body
+## Body
 
 *key*: grant_type
 
 *value*: client_credentials
 
-## Sample Request
+# Sample Request
 
-{% highlight http linenos %}
+```json
 POST /auth/realms/itsmproxy/protocol/openid-connect/token HTTP/1.1
 Host: sso.manyos.it
 Content-Type: application/x-www-form-urlencoded
@@ -49,11 +45,11 @@ Cache-Control: no-cache
 Host: sso.manyos.it
 
 grant_type=client_credentials
-{% endhighlight %}
+```
 
-## Sample Response
+# Sample Response
 
-{% highlight json linenos %}
+```json
 {
     "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJFUUYxX01tM0lxaXNscEFNdEpQb0FKQmFiVk5CajRrMXdLUEJYUFlfZDRBIn0.eyJqdGkiOiJmZWFkZjc0OS05OGFhLTQ1MmUtYThlYi04Y2JjNzFlNDNmNjYiLCJleHAiOjE1NjU2MzM1MzUsIm5iZiI6MCwiaWF0IjoxNTY1NjE1NTM1LCJpc3MiOiJodHRwczovL3Nzby5tYW55b3MuaXQvYXV0aC9yZWFsbXMvaXRzbXByb3h5IiwiYXVkIjpbImlzc20iLCJhY2NvdW50Il0sInN1YiI6IjI1NWU5MGRjLTczYWItNDJkOS1iOTUyLTYwY2VjNzE2YzRlOCIsInR5cCI6IkJlYXJlciIsImF6cCI6ImlzbXMiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiJjMmIxZGE3YS1kZGM0LTQ5M2MtYjIwYi0zN2Y0NTExYWQyZTciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Imlzc20gaXRzbXByb3h5QmFzaWMgY21kYm9iamVjdFJlYWQiLCJjbGllbnRIb3N0IjoiMjEyLjExNC4xMzAuOTMiLCJjbGllbnRJZCI6ImlzbXMiLCJjbGllbnRBZGRyZXNzIjoiMjEyLjExNC4xMzAuOTMifQ.TOdFNfiBUgu5CwWZ6IOCahJkr4FYbWM9hK5yblQR06uDaJkRx_c7NEwVRRXnYPFs9rtAgCycYwYap8hKKZqZpExQmBSmRgHzyMZVEw67V3kiFlNaok83czuE2Ka1vC8le4LbQuLmwOeIWa0UIiOZlxpskZgJ4vBomotewbKC4-w2WwB-5zieuO48aohP8voY6oyYFWNMJJyvlubDbC1eUhCmwMaTOWDw0wtkYQDxKNPX_toPxa8aRIy0rXpRYINRiAP4zsyI9IBSoyAxiHWwMbKutVpnvZsSl_Rny2lsw1xnLWQe2nXlKwAEVYZ7Bz6U6krvi_oRfpWUoP5OdfYKhg",
     "expires_in": 18000,
@@ -64,8 +60,8 @@ grant_type=client_credentials
     "session_state": "c2b1da7a-ddc4-493c-b20b-37f4511ad2e7",
     "scope": "itsmproxy cmdbobjectRead"
 }
-{% endhighlight %}
+```
 
 You can now use the access token to authorize your requests. Set a header with the key "Authorization" and the value "Bearer <access-token>".
 
-Learn more about JSON Web Tokens on [jwt.io](https://jwt.io)
+Learn more about JSON Web Tokens on [jwt.io](https://jwt.io)

package/docs/howto/{incident-worklogs.md → worklogs.md}

@@ -1,11 +1,4 @@
----
-layout: page
-title: Worklogs
-subtitle: In this guide we'll show you how to create and read worklogs.
-use-site-title: true
-gh-badge: [star, fork, follow]
-gh-repo: daattali/beautiful-jekyll
----
+# Worklogs
 
 In this guide we'll show you how to create and read worklogs. Worklogs can be used with the following object types:
 
@@ -41,13 +34,13 @@ You need to do a GET request to the /v1/incidents/*incidentId*/worklogs endpoint
 
 *Type*: Bearer
 
-Use your [API Token](token.md)
+Use your [API Token](howto/token.md)
 
 ### Sample Response
 
-GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
+GET: https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
 
-{% highlight json linenos %}
+```json
 {
     "data": [
         {
@@ -67,7 +60,7 @@ GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
         }
     ]
 }
-{% endhighlight %}
+```
 
 # Get a specifc worklog for an Incident
 
@@ -94,13 +87,13 @@ You need to do a GET request to the /v1/incidents/*incidentId*/worklogs/*worklog
 
 *Type*: Bearer
 
-Use your [API Token](token.md)
+Use your [API Token](howto/token.md)
 
 ### Sample Response
 
-GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000000533
+GET: https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000000533
 
-{% highlight json linenos %}
+```json
 {
     "data": {
         "summary": "Status Change",
@@ -116,7 +109,7 @@ GET:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs/WLG000000000533
         }
     ]
 }
-{% endhighlight %}
+```
 
 # Create a new worklog
 
@@ -141,7 +134,7 @@ To create a worklog you need to do a POST to the /v1/incidents/*incidentid*/work
 
 *Type*: Bearer
 
-Use your [API Token](token.md)
+Use your [API Token](howto/token.md)
 
 ### Body
 
@@ -152,7 +145,7 @@ Provide a summary and a detailed text within the *data* attribute.
 
 ### Sample Request
 
-POST:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
+POST: https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
 
 {% highlight json linenos %}
 {
@@ -165,7 +158,7 @@ POST:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
 
 ### Sample Response
 
-{% highlight json linenos %}
+```json
 {
     "data": {
         "summary": "Implementation update",
@@ -181,6 +174,6 @@ POST:https://*api-fqdn*/v1/incidents/INC000000000217/worklogs
         }
     ]
 }
-{% endhighlight %}
+```
 
-To learn how to hanle attachments click [here](./worklog-attachment.md)
+To learn how to hanle attachments click [here](howto/attachments.md)

package/docs/index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'SMILEconnect',
+      repo: '',
+      coverpage: true,
+      loadSidebar: true,
+      subMaxLevel: 2
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+</body>
+</html>