Skip to content

Commit

Permalink
chore: update edge documentation (#939)
Browse files Browse the repository at this point in the history
Co-authored-by: TheCatLady <[email protected]>
  • Loading branch information
some-ci and TheCatLady authored Jan 19, 2024
1 parent 521433d commit fc6cc65
Show file tree
Hide file tree
Showing 228 changed files with 6,019 additions and 1,256 deletions.
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ node_modules

*.svg
**/lottie/*.json

tsconfig.json
.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,28 @@ This guide assumes that you have already [installed](../../../getting-started/in
1. Execute the following [`search` command](../../../reference/cli/search.mdx) in [Resoto Shell](../../../reference/components/shell.mdx) or Resoto UI:

```bash
> search is(aws_api_gateway_rest_api) with(empty, --> is(aws_api_gateway_authorizer))
> search is(aws_apigateway_rest_api) with(empty, --> is(aws_api_gateway_authorizer))
# highlight-start
​kind=aws_api_gateway_rest_api, ..., region=resoto-poweruser
​kind=aws_api_gateway_rest_api, ..., account=poweruser-team
​kind=aws_apigateway_rest_api, ..., region=resoto-poweruser
​kind=aws_apigateway_rest_api, ..., account=poweruser-team
# highlight-end
```

2. Pipe the `search` command into the [`dump` command](../../../reference/cli/dump.mdx):

```bash
> search is(aws_api_gateway_rest_api) with(empty, --> is(aws_api_gateway_authorizer)) | dump
> search is(aws_apigateway_rest_api) with(empty, --> is(aws_api_gateway_authorizer)) | dump
# highlight-start
​reported:
​ id: /aws/apigateway/123
​ name: some-name
​ ctime: '2022-12-05T22:53:14Z'
​ kind: aws_api_gateway_rest_api
​ kind: aws_apigateway_rest_api
​ age: 2mo28d
# highlight-end
```

The command output will list the details of all non-compliant [`aws_api_gateway_rest_api` resources](../../../reference/unified-data-model/aws.mdx#aws_api_gateway_rest_api).
The command output will list the details of all non-compliant [`aws_apigateway_rest_api` resources](../../../reference/unified-data-model/aws.mdx#aws_apigateway_rest_api).

## Remediation

Expand All @@ -58,7 +58,7 @@ Please refer to the [AWS API Gateway documentation](https://docs.aws.amazon.com/

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_api_gateway_rest_api` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_api_gateway_rest_api)
- [`aws_apigateway_rest_api` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_apigateway_rest_api)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,28 @@ This guide assumes that you have already [installed](../../../getting-started/in
1. Execute the following [`search` command](../../../reference/cli/search.mdx) in [Resoto Shell](../../../reference/components/shell.mdx) or Resoto UI:

```bash
> search is(aws_api_gateway_stage) and stage_client_certificate_id==null <-[2]- is(aws_api_gateway_rest_api)
> search is(aws_apigateway_stage) and stage_client_certificate_id==null <-[2]- is(aws_apigateway_rest_api)
# highlight-start
​kind=aws_api_gateway_stage, ..., region=resoto-poweruser
​kind=aws_api_gateway_stage, ..., account=poweruser-team
​kind=aws_apigateway_stage, ..., region=resoto-poweruser
​kind=aws_apigateway_stage, ..., account=poweruser-team
# highlight-end
```

2. Pipe the `search` command into the [`dump` command](../../../reference/cli/dump.mdx):

```bash
> search is(aws_api_gateway_stage) and stage_client_certificate_id==null <-[2]- is(aws_api_gateway_rest_api) | dump
> search is(aws_apigateway_stage) and stage_client_certificate_id==null <-[2]- is(aws_apigateway_rest_api) | dump
# highlight-start
​reported:
​ id: /aws/apigateway/123
​ name: some-name
​ ctime: '2022-12-05T22:53:14Z'
​ kind: aws_api_gateway_stage
​ kind: aws_apigateway_stage
​ age: 2mo28d
# highlight-end
```

The command output will list the details of all non-compliant [`aws_api_gateway_stage` resources](../../../reference/unified-data-model/aws.mdx#aws_api_gateway_stage).
The command output will list the details of all non-compliant [`aws_apigateway_stage` resources](../../../reference/unified-data-model/aws.mdx#aws_apigateway_stage).

## Remediation

Expand All @@ -58,7 +58,7 @@ Please refer to the [AWS API Gateway documentation](https://aws.amazon.com/blogs

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_api_gateway_stage` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_api_gateway_stage)
- [`aws_apigateway_stage` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_apigateway_stage)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,28 @@ This guide assumes that you have already [installed](../../../getting-started/in
1. Execute the following [`search` command](../../../reference/cli/search.mdx) in [Resoto Shell](../../../reference/components/shell.mdx) or Resoto UI:

```bash
> search is(aws_api_gateway_stage) and stage_web_acl_arn==null
> search is(aws_apigateway_stage) and stage_web_acl_arn==null
# highlight-start
​kind=aws_api_gateway_stage, ..., region=resoto-poweruser
​kind=aws_api_gateway_stage, ..., account=poweruser-team
​kind=aws_apigateway_stage, ..., region=resoto-poweruser
​kind=aws_apigateway_stage, ..., account=poweruser-team
# highlight-end
```

2. Pipe the `search` command into the [`dump` command](../../../reference/cli/dump.mdx):

```bash
> search is(aws_api_gateway_stage) and stage_web_acl_arn==null | dump
> search is(aws_apigateway_stage) and stage_web_acl_arn==null | dump
# highlight-start
​reported:
​ id: /aws/apigateway/123
​ name: some-name
​ ctime: '2022-12-05T22:53:14Z'
​ kind: aws_api_gateway_stage
​ kind: aws_apigateway_stage
​ age: 2mo28d
# highlight-end
```

The command output will list the details of all non-compliant [`aws_api_gateway_stage` resources](../../../reference/unified-data-model/aws.mdx#aws_api_gateway_stage).
The command output will list the details of all non-compliant [`aws_apigateway_stage` resources](../../../reference/unified-data-model/aws.mdx#aws_apigateway_stage).

## Remediation

Expand All @@ -58,7 +58,7 @@ Please refer to the [AWS API Gateway documentation](https://docs.aws.amazon.com/

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_api_gateway_stage` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_api_gateway_stage)
- [`aws_apigateway_stage` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_apigateway_stage)

## External Links

Expand Down
7 changes: 6 additions & 1 deletion docs/reference/api/abort-a-batch-update.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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
Expand Down Expand Up @@ -70,7 +72,10 @@ import TabItem from "@theme/TabItem";
</div>
</details><div>
<div>
<ApiTabs>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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
Expand Down Expand Up @@ -3576,7 +3578,10 @@ Add or update the current defined configuration model.
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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
Expand Down Expand Up @@ -3600,7 +3602,10 @@ Add or update the current defined model.
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/api/add-subscription-to-subscriber.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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
Expand Down Expand Up @@ -99,7 +101,10 @@ Add a specific subscription to a subscriber.
</div>
</details><div>
<div>
<ApiTabs>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/api/commit-a-batch-update.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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
Expand Down Expand Up @@ -70,7 +72,10 @@ import TabItem from "@theme/TabItem";
</div>
</details><div>
<div>
<ApiTabs>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/api/create-a-new-graph.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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
Expand Down Expand Up @@ -65,7 +67,10 @@ Create a new graph
</div>
</details><div>
<div>
<ApiTabs>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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
Expand Down Expand Up @@ -135,7 +137,10 @@ import TabItem from "@theme/TabItem";
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
Expand Down
Loading

0 comments on commit fc6cc65

Please sign in to comment.