New kb

.gitignore

@@ -7,9 +7,9 @@
 # Generated files
 .docusaurus
 .cache-loader
-/docs/SDK-API/*.mdx
+/docs/APIs-and-SDKs/SDK-API*.mdx
 /docs/Web-Console-API/*.mdx
-/docs/SDK-API/*.js
+/docs/APIs-and-SDKs/SDK-API*.js
 /docs/Web-Console-API/*.js
 
 # Misc
@@ -24,3 +24,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 .idea
+.claude/tasks/
+.claude/audits/
+openapi_console_bk/

docs/APIs-and-SDKs/SDK-API/absmartly-collector-api.info.mdx

@@ -0,0 +1,25 @@
+---
+id: absmartly-collector-api
+title: "ABsmartly Collector API"
+description: "An OpenAPI Specification that describes the ABsmartly Collector API. This API is mainly used when using ABsmartly in a language that does not yet have a supported SDK."
+sidebar_label: Introduction
+sidebar_position: 0
+hide_title: true
+custom_edit_url: null
+---
+
+import ApiLogo from "@theme/ApiLogo";
+import SchemaTabs from "@theme/SchemaTabs";
+import TabItem from "@theme/TabItem";
+import Export from "@theme/ApiExplorer/Export";
+
+<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 1.0.0</span>
+
+<h1 className={"openapi__heading"}>ABsmartly Collector API</h1>
+
+
+
+An OpenAPI Specification that describes the ABsmartly Collector API. This API is mainly used when using ABsmartly in a language that does not yet have a supported SDK.
+
+<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}><div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>X-API-Key</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>API Support: <a href={"mailto:api@absmartly.com"}>api@absmartly.com</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3></div>
+

docs/APIs-and-SDKs/SDK-API/collector-health-check.api.mdx

@@ -0,0 +1,44 @@
+---
+id: collector-health-check
+title: "Check Service Health"
+description: "A GET request to check that the service is running as expected."
+sidebar_label: "Check Service Health"
+hide_title: true
+hide_table_of_contents: true
+api: eJytU02L2zAQ/SvDnL1OttCLT3W3yzbsoYGkUAg5TOTZSNSWFGmcxhj/9yLbIWlLe+rJ8ui9+Xjz1KPQMWKxQ+XqmpW4gPsMK44qGC/GWSywhJfnLQQ+tRwFxIHSrL6DaBIQzRA5nI1iMBFCa62xR6AIfPGshKscM3SeA6VsqwqLW6nPTLXop5QNMwwcvbORIxY9vlsu0+fXRjYczhxSHT0yOxwyfP9vpHVyQw8ZNizapS6OLJihJ9FY4OIKyTCO1KRJj22osUAt4mOxWESy1cFdcjrEhoLUXW7c4vyIwz6xVBuMdCOt9OaV03F/f7VRmptpuiugR+k8Y4E0BTK01KT/bw/levUwhUwaSDNVHEaVTq0JXGEhoeU0kbFvbkxlpE7c8uPcHjxdhYZyvcIM01yTPo/5Ml/iH4u28MWzLdcr2HhW5s2ocWvTqifsgeO49L9UyWGrTUynJH5DxtYdtJEr+KHZQhuTO25cY4GgJnts6chzGcfT1joW0HRmIIit9y4IV7D59JoMpZwVUpLGnhUbm55gmCE3ZOpJ1w+3dSnXJMfURrGNfEdeB+eDYaEwmcS7KA3ZO8RoUtjMTp+M+7t+/dgWW/kvb2Z2hvBFFr4mY1ProyH72bU7vLp2n6F2UVKo7w8U+WuohyGFTy2H0YkZnikYOiSL7Pb3D+HleYvD8BN8TGJM
+sidebar_class_name: "get api-method"
+info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api
+custom_edit_url: null
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import Markdown from "@theme/Markdown";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+
+<h1 className={"openapi__heading"}>Check Service Health</h1>
+
+<MethodEndpoint method={"get"} path={"/healthy"}></MethodEndpoint>
+
+
+
+A GET request to check that the service is running as expected.
+
+<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
+
+Server is healthy
+
+</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>
+
+Server is not healthy
+
+</div><div></div></TabItem></ApiTabs></div></div>
+

docs/APIs-and-SDKs/SDK-API/context-create.api.mdx

@@ -0,0 +1,66 @@
+---
+id: context-create
+title: "Create a Context"
+description: "A POST request for creating a new context and assigning variants to your users."
+sidebar_label: "Create a Context"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWF9v2zYQ/yoEnzZAie3YcxI9zU37kHXDgibpBsRBe5JOEluJVEnKsWf4uw9HypbcuF7mpigGLA+JQt4df/f/yCW3kBke3vFYSYtzy+8DnqCJtaisUJKHfMKufr++YRo/1WgsS5VmsUawQmYMmMQH1rAykAkDY0QmaW8GWoC0hlnFFqrWrDaozTEPuKpQA0m/THi4PviCZCIPeAUaSrSoCdaSSyiRh/zPo0mG0vKACwKVIySoecAJltCY8NDqGj/HfpMjuzWoPTNTqUdy/fI14cA5lFVB0iEyJWhbLI5+gRkcXb98zWaD4/7xgAfcxDmWwMMlt4uKiI3VQmZ8tQo66F7JmdBKlodhxJabCckechHnBJWBRqZr6QzqoOO8Qi2I0ByzmxwNshgki5Clqib7y8S7BxOS5HgmLxrt2B8YsQsljSqQGbTkQ7NtiQRnWKiq0eNpuk+qqhCx8+gBukPL/Z11f3h4OETno7eozdfrPvNSnmgApuQW+P4O4EJazBySVOkSrF8aj/hqde/RobEvVLIgnv1gb6WwhiVgwRUAj9GqxtzM5rhVBZrcb6pB4zGSwQia+Wq3TeVUvn///oNRciqXU8nY1Ck95SGbcio070Qy5azXozhh5DVKfoJZr1F4rproiGkEo5PT8TiG8XAwTE7G6ej8/OwnPD0/T9NROjw976fR2RhT6KcxjsaYREOEszRKBwjDUf+sPW0GRf3ZcTnYjUethvijkNnxVK6cFlOKHGc9ackTnaDokYa09si3KvqAsd0KsjtOhxmq4JWmGmsFGmLxyy0vaA0LilaLpfknmW7vkUjP8XmKdJOpcQJfBWTjXbSlkL+izGzOw0HAS5iv/xuP+l1JX+sZylxuhXXCKAj5qrty4eP2jU8H2luRBUylpPHKnvT79Gc7I67rOEZjntd1Ae9kzP+OfIIjty12oGlE4in1uoe5Mh/wpoyROQqRiahA7+5UZI8tuWWb3aV3eOKtJcq6dCV7Y5vhqgvgcDknqwb8XpfivHoXgZSo38WqUJp8u9b1X59dwtx/D05OO4cMVh2rtUIjpQoE2YVD/Yb8WCcCZYy/CVOCjfP9TCkUhriUFpmQULz9BvAbT+8wpayLAqIN+E5Yvtq06MkmLr9Qb3yFaQrOaFeNeQHJeu5+rjoTq4SCuERjINtRD9z+U0aIVsauSam1h9YUX42Og8c63kqoba60+AtdjUkwhbqwuwhp/IlpSkAn9D9vEcdhc0W3oEo5H1dAdZP31rexgBvUs/VdqNYFzZfWVibs9QzIJFLz483l5Vio3mzAabgzGNda2IVjm1TiNdLnfXfrmqzjVVwTtNXTLwSdeffq8sgv7ZtxSSWy/pt2tny1zqhN+7rbHLNuLU1neYYGcU91VKbK6dIYvJ0lL1RRYGyVZpOrS6rvzeAecrrs9fmjq69kv1coJ1eX7LrCWKTrWd0NdJ42QuMGvS+cQhcVYeiLCcNKELJY0E04YQ85SlYbGu5bXiEZsAJkVkOGzTEKDZPKsgValsMMGTBTV5XSlArNVZbiBWKXCY3LHGhPRnWzBFF4x/7cxkusSgrbQsRIlahlvtKq0gIt6IWLXYrOEmSHwl/XGbCLTaRu2W7ZJuc3eEFo4od4elUBQrrphLJj2aTQ1oNGTskV3vHlMgKDt7pYrWj5U43apUXT/VxBv6MQasKbQjURhjaSpuXsUfOHN00u/Mj2vzvsRP+RErDzzOFuETzknK6dB4P43g8Le1XdfjN5HoW/92vCft9uPZQ8v8IHPSE8FXHnmWMLuSe98PiObkhaS/GoLbcckzjGyu6lve80SCohPOBR81xRuq7MNdCTDf0O+ZRPuXtdJAmur7n1JV/XUx5yL5d+/gYMTisZ
+sidebar_class_name: "post api-method"
+info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api
+custom_edit_url: null
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import Markdown from "@theme/Markdown";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+
+<h1 className={"openapi__heading"}>Create a Context</h1>
+
+<MethodEndpoint method={"post"} path={"/context"}></MethodEndpoint>
+
+
+
+A POST request for creating a new context and assigning variants to your users.
+
+## Request
+
+<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"X-Agent","in":"header","required":true,"description":"The User-Agent of your SDK.","example":"absmartly-Java-SDK v1.0.1","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"X-Environment","in":"header","required":true,"description":"The environment in which you are running your experiments. These can be found and created in your ABsmartly Web Console settings.","example":"development","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"X-Application","in":"header","required":true,"description":"The application in which you are running your experiments. These can be found and created in your ABsmartly Web Console settings.","example":"www","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"X-Application-Version","in":"header","required":true,"description":"The application version which you are running your experiments on.","example":0,"schema":{"type":"integer","format":"int64"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
+
+Units data for which to create the context and variant assignments. Unit types can be found and created in your ABsmartly Web Console settings.
+
+```json
+{
+  "type": "user_id" // The name of the unit type
+  "uid": "4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408" // The value of the unit that you are tracking.
+}
+```
+
+
+</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>units</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"user_id"}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 640 characters`"} schema={{"type":"string","minLength":1,"maxLength":640,"example":"4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
+
+Success
+
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>units</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"user_id"}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 640 characters`"} schema={{"type":"string","minLength":1,"maxLength":640,"example":"4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>assignments</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","minimum":0,"example":3}}></SchemaItem><SchemaItem collapsible={false} name={"iteration"} required={true} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","minimum":0,"example":2}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"exp_banner_color"}}></SchemaItem><SchemaItem collapsible={false} name={"variant"} required={true} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 127`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":127,"example":1}}></SchemaItem><SchemaItem collapsible={false} name={"eligible"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"audienceMismatch"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"originalVariant"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 127`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":127,"example":1}}></SchemaItem><SchemaItem collapsible={false} name={"config"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"units\": [\n    {\n      \"type\": \"user_id\",\n      \"uid\": \"4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408\"\n    }\n  ],\n  \"assignments\": [\n    {\n      \"id\": 3,\n      \"iteration\": 2,\n      \"name\": \"exp_banner_color\",\n      \"variant\": 1,\n      \"eligible\": true,\n      \"audienceMismatch\": false,\n      \"originalVariant\": 1,\n      \"config\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
+
+Bad request
+
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"code\": 0,\n  \"message\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
+
+Unauthorized
+
+</div><div></div></TabItem><TabItem label={"default"} value={"default"}><div>
+
+Unexpected error
+
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"code"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"code\": 0,\n  \"message\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
+