Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

automated generation of docs from buildkite #1036

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+16,116 −366
Draft

automated generation of docs from buildkite #1036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d45e7b
automated generation of docs from buildkite
Nov 15, 2024
645d3db
add cli-api to sidebar
Alice-Lilith Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8,160 changes: 8,160 additions & 0 deletions docs/agent/cli-api.mdx
View file
Open in desktop

Large diffs are not rendered by default.

727 changes: 375 additions & 352 deletions docs/agent/cli.mdx
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions docs/api/examples/_abuse_reports_create_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"metadata":"{\"incident_id\":1233122}","urls":["http://legit-facebook-login.ngrok.io/login"]}' \
https://api.ngrok.com/abuse_reports
```
20 changes: 20 additions & 0 deletions docs/api/examples/_abuse_reports_create_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"created_at": "2024-11-15T17:26:25Z",
"hostnames": [
{
"hostname": "legit-facebook-login.ngrok.io",
"status": "PENDING"
}
],
"id": "abrp_2otazEdVBp7Pjr3TVPikrTLPAIk",
"metadata": "{\"incident_id\":1233122}",
"status": "PENDING",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2otazEdVBp7Pjr3TVPikrTLPAIk",
"urls": ["http://legit-facebook-login.ngrok.io/login"]
}
```
11 changes: 11 additions & 0 deletions docs/api/examples/_abuse_reports_get_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/abuse_reports/abrp_2otazEdVBp7Pjr3TVPikrTLPAIk
```
20 changes: 20 additions & 0 deletions docs/api/examples/_abuse_reports_get_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"created_at": "2024-11-15T17:26:25Z",
"hostnames": [
{
"hostname": "legit-facebook-login.ngrok.io",
"status": "PENDING"
}
],
"id": "abrp_2otazEdVBp7Pjr3TVPikrTLPAIk",
"metadata": "{\"incident_id\":1233122}",
"status": "PENDING",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2otazEdVBp7Pjr3TVPikrTLPAIk",
"urls": ["http://legit-facebook-login.ngrok.io/login"]
}
```
13 changes: 13 additions & 0 deletions docs/api/examples/_agent_ingresses_create_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"acme devices","domain":"connect.acme.com"}' \
https://api.ngrok.com/agent_ingresses
```
22 changes: 22 additions & 0 deletions docs/api/examples/_agent_ingresses_create_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-15T17:26:26Z",
"description": "acme devices",
"domain": "connect.acme.com",
"id": "agin_2otazKa9AmvitfEYcbLEkVxPifQ",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2otazKa9AmvitfEYcbLEkVxPifQ"
}
```
11 changes: 11 additions & 0 deletions docs/api/examples/_agent_ingresses_delete_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2otazKa9AmvitfEYcbLEkVxPifQ
```
Empty file added docs/api/examples/_agent_ingresses_delete_response.md
View file
Open in desktop
Empty file.
11 changes: 11 additions & 0 deletions docs/api/examples/_agent_ingresses_get_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2otazKa9AmvitfEYcbLEkVxPifQ
```
23 changes: 23 additions & 0 deletions docs/api/examples/_agent_ingresses_get_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-15T17:26:26Z",
"description": "ACME Co. Device Ingress",
"domain": "connect.acme.com",
"id": "agin_2otazKa9AmvitfEYcbLEkVxPifQ",
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2otazKa9AmvitfEYcbLEkVxPifQ"
}
```
11 changes: 11 additions & 0 deletions docs/api/examples/_agent_ingresses_list_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses
```
28 changes: 28 additions & 0 deletions docs/api/examples/_agent_ingresses_list_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"ingresses": [
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-15T17:26:26Z",
"description": "acme devices",
"domain": "connect.acme.com",
"id": "agin_2otazKa9AmvitfEYcbLEkVxPifQ",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2otazKa9AmvitfEYcbLEkVxPifQ"
}
],
"next_page_uri": null,
"uri": "https://api.ngrok.com/agent_ingresses"
}
```
13 changes: 13 additions & 0 deletions docs/api/examples/_agent_ingresses_update_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X PATCH \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"ACME Co. Device Ingress","metadata":"{\"device_sku\": \"824JS4RZ1F8X\"}"}' \
https://api.ngrok.com/agent_ingresses/agin_2otazKa9AmvitfEYcbLEkVxPifQ
```
23 changes: 23 additions & 0 deletions docs/api/examples/_agent_ingresses_update_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-11-15T17:26:26Z",
"description": "ACME Co. Device Ingress",
"domain": "connect.acme.com",
"id": "agin_2otazKa9AmvitfEYcbLEkVxPifQ",
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2otazKa9AmvitfEYcbLEkVxPifQ"
}
```
13 changes: 13 additions & 0 deletions docs/api/examples/_api_keys_create_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"ad-hoc dev testing","metadata":"{\"environment\":\"dev\"}"}' \
https://api.ngrok.com/api_keys
```
15 changes: 15 additions & 0 deletions docs/api/examples/_api_keys_create_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"created_at": "2024-11-15T17:26:02Z",
"description": "ad-hoc dev testing",
"id": "ak_2otawMS7frOZs3w8bpePW0N1Iko",
"metadata": "{\"environment\":\"dev\"}",
"owner_id": "usr_2otawLHkq5cU4yJenLp73PukWVQ",
"token": "2otawMS7frOZs3w8bpePW0N1Iko_48dHLWSodPv4DMvpyZ3nM",
"uri": "https://api.ngrok.com/api_keys/ak_2otawMS7frOZs3w8bpePW0N1Iko"
}
```
11 changes: 11 additions & 0 deletions docs/api/examples/_api_keys_delete_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/api_keys/ak_2otawMS7frOZs3w8bpePW0N1Iko
```
Empty file added docs/api/examples/_api_keys_delete_response.md
View file
Open in desktop
Empty file.
11 changes: 11 additions & 0 deletions docs/api/examples/_api_keys_get_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/api_keys/ak_2otawMS7frOZs3w8bpePW0N1Iko
```
15 changes: 15 additions & 0 deletions docs/api/examples/_api_keys_get_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"created_at": "2024-11-15T17:26:02Z",
"description": "ad-hoc dev testing",
"id": "ak_2otawMS7frOZs3w8bpePW0N1Iko",
"metadata": "{\"environment\":\"dev\", \"owner_id\": 123}",
"owner_id": "usr_2otawLHkq5cU4yJenLp73PukWVQ",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2otawMS7frOZs3w8bpePW0N1Iko"
}
```
11 changes: 11 additions & 0 deletions docs/api/examples/_api_keys_list_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/api_keys
```
29 changes: 29 additions & 0 deletions docs/api/examples/_api_keys_list_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"keys": [
{
"created_at": "2024-11-15T17:26:02Z",
"description": "api key for example generation",
"id": "ak_2otawKwzgQ4NcbC12ZJQw24hL6r",
"owner_id": "usr_2otawLHkq5cU4yJenLp73PukWVQ",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2otawKwzgQ4NcbC12ZJQw24hL6r"
},
{
"created_at": "2024-11-15T17:26:02Z",
"description": "ad-hoc dev testing",
"id": "ak_2otawMS7frOZs3w8bpePW0N1Iko",
"metadata": "{\"environment\":\"dev\"}",
"owner_id": "usr_2otawLHkq5cU4yJenLp73PukWVQ",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2otawMS7frOZs3w8bpePW0N1Iko"
}
],
"next_page_uri": null,
"uri": "https://api.ngrok.com/api_keys"
}
```
13 changes: 13 additions & 0 deletions docs/api/examples/_api_keys_update_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X PATCH \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"metadata":"{\"environment\":\"dev\", \"owner_id\": 123}"}' \
https://api.ngrok.com/api_keys/ak_2otawMS7frOZs3w8bpePW0N1Iko
```
15 changes: 15 additions & 0 deletions docs/api/examples/_api_keys_update_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Response

```json
{
"created_at": "2024-11-15T17:26:02Z",
"description": "ad-hoc dev testing",
"id": "ak_2otawMS7frOZs3w8bpePW0N1Iko",
"metadata": "{\"environment\":\"dev\", \"owner_id\": 123}",
"owner_id": "usr_2otawLHkq5cU4yJenLp73PukWVQ",
"token": null,
"uri": "https://api.ngrok.com/api_keys/ak_2otawMS7frOZs3w8bpePW0N1Iko"
}
```
13 changes: 13 additions & 0 deletions docs/api/examples/_bot_users_create_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

#### Example Request

```bash
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"name":"new bot user from API"}' \
https://api.ngrok.com/bot_users
```
Loading