1.0.33

markdown/api.md

@@ -1,8 +0,0 @@
----
-name: Tools
---- 
-# AWMP - Tools
-In order to simplify AWPM certification there are some check tools available
-
-## checkspec
-checkspec automatically checks some technical parts of the awpm-spec like brandfile-spec consistency across projects.

markdown/endpoints.md

@@ -0,0 +1,24 @@
+# API
+
+## Balance Endpoint
+```text
+https://balance.api.global
+```
+api.global uses a balancing endpoint to balance clients between dynamic workers. The balance endpoint will assign you a dynamic endpoint,a secret that proves you got assigned that endpoint, a max timeframe that the worker is guranteed to be available and a max idle timeframe between requests, before your spot is given to the next api client balancing applicant. You can always come back here and ask for a new worker assignment.
+
+
+## Async Endpoint
+```text
+https://async.api.global
+```
+For requests that are not sensitive for timely execution there is a async endpoint, that will schedule an request for "later point in time" exection. Any requests going there need to register a webhook within their account for transmitting responses in an asynchronious fashion.
+
+## Worker Endpoints
+```
+[4chd76gf].api.global
+```
+Worker endpoints are assigned to you on a dynamic basis
+
+!!! hint
+    If you are using TypeScript we can not recommend enough to use our TypeScript npm packages for super easy integration.
+    They are maintained by us ourselves and hide most complex stuff from you so you can focus on using the tools.

markdown/index.md

@@ -1,8 +1,19 @@
-# Bellini.io Documentation
+# Getting started with api.global
-headless Open Source CMS
+
+!!! info
+    Use the search box for quickly finding what you are looking for.
 
 ## What is this?
-bellini.io enables easy maintance of content for large scale commercial websites.
+api.global is the high availability api endpoint for all products created by [lossless](https://lossless.com).
+
+!!! hint
+    Most products offer TypeScript packages on npm that simplify interaction with the API for the product specific use case. As of now those are:
+
+    * [@layer.io/api](https://npmjs.org/layer.io/api)
+    * [@social.io/api](https://npmjs.org/layer.io/api)
+    * [@onboardme/api](https://npmjs.org/layer.io/api)
+    * [@inwork/api](https://npmjs.org/layer.io/api)
 
 ## What does this documentation cover?
-This documentation explains how to interface with bellini.io and how to use its APIs
+This documentation explains how to structure api calls to api.global and to be aware of the mechanics of load distribution.
+We strongly recommend checking out our npm package that implements the hard stuff for you.

markdown/limitations.md

@@ -0,0 +1,16 @@
+# Limitations
+
+api.global is deplyoing a few hard limitations on a per account basis:
+
+* 1 million API requests per hour
+* 12 million API requests per day
+* max of 10 assigned workers at any given time.
+
+!!! hint
+    running into one of those limitations will result in a 429 status code with an info of when to try again attached as json payload in the response.
+
+    ```json
+    {
+      "retryIn": 3600000
+    }
+    ```

markdown/nodejs.md

@@ -0,0 +1,3 @@
+# NodeJS SDK
+
+api.global offers a nodejs sdk that makes it easy to implement api.global features into your own software

markdown/sdks/nodejs.md

@@ -1,4 +0,0 @@
----
-name: NodeJS SDK
----
-bellini.io offers a TypeScript package which is the recommended way of interfacing with bellini.io

markdown/support.md

@@ -0,0 +1,3 @@
+# Support
+
+api.global is covered by Lossless Support. To see available support packages visit https://lossless.support

mkdocs.yml

@@ -1,5 +1,5 @@
 # Project information
-site_name: api.global - high availability API
+site_name: api.global - documentation
 site_description: high availability API made by lossless
 site_author: Lossless GmbH
 site_url: https://docs.api.global/
@@ -10,8 +10,8 @@ site_dir: public
 
 # Repository
 repo_name: apiglobal/docs
-repo_url: https://gitlab.com/apiglobal/docs
+repo_url:
-edit_uri: "https://gitlab.com/apiglobal/docs/edit/master/markdown/"
+edit_uri: ""
 
 # Copyright
 copyright: 'Copyright © 2016 - 2019 Lossless GmbH'
@@ -86,7 +86,9 @@ markdown_extensions:
 
 # Page tree
 nav:
-  - Getting Started: index.md
+  - Overview:
-  - API:
+    - Getting Started: index.md
-    - REST: api.md
+    - Limitations: limitations.md
-    - NodeJS: sdks/nodejs.md
+    - Endpoints: endpoints.md
+    - NodeJS: nodejs.md
+    - Support: support.md

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "awpm.xyz",
-  "version": "1.0.27",
+  "version": "1.0.33",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "awpm.xyz",
-  "version": "1.0.27",
+  "version": "1.0.33",
   "description": "the specification for the awesome workplace manifesto",
   "main": "dist/index.js",
   "scripts": {

readme.md

@@ -1,4 +1,4 @@
-# @bellini/docs
+# @apiglobal/private/docs
 Open Source headless CMS
 
 ## Availabililty and Links