1.0.34

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
+```
+https://[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/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
+    }
+    ```

mkdocs.yml

@@ -88,5 +88,7 @@ markdown_extensions:
 nav:
   - Overview:
     - Getting Started: index.md
+    - Limitations: limitations.md
+    - Endpoints: endpoints.md
     - NodeJS: nodejs.md
     - Support: support.md

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "awpm.xyz",
-  "version": "1.0.28",
+  "version": "1.0.34",
   "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