Skip to content

Commit

Permalink
Chaos Backend API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Lai authored and Alexander Lai committed Aug 3, 2024
1 parent f0fe5d6 commit a87f39d
Show file tree
Hide file tree
Showing 53 changed files with 7,686 additions and 11,229 deletions.
35 changes: 35 additions & 0 deletions chaos-docs/docs/Chaos Backend APIs/chaos-api.info.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
id: chaos-api
title: "Chaos API"
description: ""
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
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"}
children={"Version: 1.0.0"}
>
</span>

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Chaos API"}
>
</Heading>







307 changes: 307 additions & 0 deletions chaos-docs/docs/Chaos Backend APIs/create-campaign.api.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,307 @@
---
id: create-campaign
title: "createCampaign"
description: "Creates a new campaign inside specified organisation."
sidebar_label: "createCampaign"
hide_title: true
hide_table_of_contents: true
api: eJydVU1v2zgQ/SvEnHYBxpITZ7Hgpcimewi2QIN8XBoYiwk5tthKJEtSTVxB/70YyXVUJ3WL6CKJ4jy9eZw304EPFDFb7y4MKNCRMNM5NgHt2oGEgBEbyhQTqLsOHDYECqwBCdaBgoC5AgmGko42MA4oeB/X6GwaYMXFW5AQ6XNrIxlQObYkIemKGgTVQd6EAdFlWlMECSsfG8zj0l8L6PvlPvz5QDIJFI4ehN6SFdYla0ikQNquLBnhJzRmICHjmrP4gR4sR3KU8j/ebJjRPlftXSaX+ROGUFs9BBYfE5PpJqmEyGJmS4nfRql2CaYcrVuDBHrEJtS8dFweL8R1e69909icicQV6dja3PDv+r20DyGdRRIb3wp61DaTEdmLBj+RQGHsakWRnKY3jJgyxpz+x/xrZkflydH89Gb+tzo+VYuT2el8/oEhyJnfBVi8ADBcrHkK3qVRquOy5NteEf0Hr9a+oZRw/Qv5r1utKaVVW9cbMRa+2VXTbMd0UZ48J3ebKAqbhPNZoBNoGuuEXx0ovldmQjH6eDiPW4dtrny0X8lsWfcSGsqVZ0sHn/Jg5FyBgmLKq+is6Qv95PZE8ct3q7exBgVVziGpotAV+jTTiZLXMwyhwGCf+f4yetPqwfUjEvRyCqSKovYa68qnrE7KsnwR5R1v2QEsJbBGV08e/fd75rt2dNhI+/i/Z5YfvPJzQ0z8cKDouVmu/HCMNg+Hds56irPLC5DAko/U5rNyVvJ2PrQG3STHsUDFpDXvdYddgb2+P44llukxF6FG65jJcHrdtnzuYBoDEtQwCXYVtJTAZ8sbu+4eE93Guu95+XNLcQPqbinhC0aL96zCXQfGJn42oFZYJzqQ1R9X2778p3g+X16kvl1Et2GRsW75DSR8os04w/plL6EiNBQHMuOH8/GXRzcc/hT4zLVc22PEmdYU8sG9y4kjL99f34CE++28abzhmIgPPCjxYSTpBwmGHjCsdVCjW7dDV4MRk69vz4mgeQ==
sidebar_class_name: "post api-method"
info_path: docs/Chaos Backend APIs/chaos-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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"createCampaign"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/organisation/{id}/campaign"}
>

</MethodEndpoint>



Creates a new campaign inside specified organisation.

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"id","in":"path","description":"Organisation ID","required":true,"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><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"2024 Subcommittee Recruitment"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"description"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"Are you excited to make a difference?"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"starts_at"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"2024-03-15T18:25:43.511Z"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"ends_at"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"2024-04-15T18:25:43.511Z"}}
>

</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>


OK


</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={"message"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"Successfully created campaign."}}
>

</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"message\": \"Successfully created campaign.\"\n}"}
language={"json"}
>

</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"403"}
value={"403"}
>
<div>


User is not an admin of specified organisation.


</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={"error"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"Unauthorized"}}
>

</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"error\": \"Unauthorized\"\n}"}
language={"json"}
>

</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>

Loading

0 comments on commit a87f39d

Please sign in to comment.