1.0.31

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,18 @@
+# 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 

markdown/limitations.md

@@ -4,6 +4,7 @@ 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.

mkdocs.yml

@@ -89,5 +89,6 @@ 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.29",
+  "version": "1.0.31",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

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