Skip to content

Commit

Permalink
update documentation for region field description to mark it as "depr…
Browse files Browse the repository at this point in the history 
…ecated" (#432)

## Why

Global network is upon us. We don't want to be confusing or misleading
customers by having outdated documentation. Lets update it!

## Validation

Checked all the places where the old text was present, and ran locally

Eg: Example below

<img width="1241" alt="image"
src="https://github.com/ngrok/ngrok-docs/assets/14898995/ed7d835c-9e09-4791-81a2-187f60cbdfa4">
  • Loading branch information
@KristopherPaulsen
KristopherPaulsen authored Oct 4, 2023
1 parent 5988675 commit 774ad23
Show file tree
Hide file tree
Showing 9 changed files with 94 additions and 94 deletions.
82 changes: 41 additions & 41 deletions docs/api/resources/reserved-addrs.mdx
View file

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions docs/api/resources/reserved-domains.mdx
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/events/_reserved-addr-create.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

| &nbsp; | &nbsp; | &nbsp; |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| description | string | human-readable description of what this reserved address will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
| region | string | reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) |
| &nbsp; | &nbsp; | &nbsp; |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| description | string | human-readable description of what this reserved address will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
| region | string | deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) |
22 changes: 11 additions & 11 deletions docs/events/_reserved-addr-list.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

| &nbsp; | &nbsp; | &nbsp; |
| ------------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| id | string | unique reserved address resource identifier |
| uri | string | URI of the reserved address API resource |
| created_at | string | timestamp when the reserved address was created, RFC 3339 format |
| description | string | human-readable description of what this reserved address will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
| addr | string | hostname:port of the reserved address that was assigned at creation time |
| region | string | reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) |
| uri | string | URI of the reserved address list API resource |
| next_page_uri | string | URI of the next page, or null if there is no next page |
| &nbsp; | &nbsp; | &nbsp; |
| ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| id | string | unique reserved address resource identifier |
| uri | string | URI of the reserved address API resource |
| created_at | string | timestamp when the reserved address was created, RFC 3339 format |
| description | string | human-readable description of what this reserved address will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
| addr | string | hostname:port of the reserved address that was assigned at creation time |
| region | string | deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) |
| uri | string | URI of the reserved address list API resource |
| next_page_uri | string | URI of the next page, or null if there is no next page |
18 changes: 9 additions & 9 deletions docs/events/_reserved-addr.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

| &nbsp; | &nbsp; | &nbsp; |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| id | string | unique reserved address resource identifier |
| uri | string | URI of the reserved address API resource |
| created_at | string | timestamp when the reserved address was created, RFC 3339 format |
| description | string | human-readable description of what this reserved address will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
| addr | string | hostname:port of the reserved address that was assigned at creation time |
| region | string | reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) |
| &nbsp; | &nbsp; | &nbsp; |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| id | string | unique reserved address resource identifier |
| uri | string | URI of the reserved address API resource |
| created_at | string | timestamp when the reserved address was created, RFC 3339 format |
| description | string | human-readable description of what this reserved address will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
| addr | string | hostname:port of the reserved address that was assigned at creation time |
| region | string | deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) |
20 changes: 10 additions & 10 deletions docs/events/_reserved-domain-create.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->

| &nbsp; | &nbsp; | &nbsp; |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | string | the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io. |
| domain | string | hostname of the reserved domain |
| region | string | reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) |
| description | string | human-readable description of what this reserved domain will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. |
| certificate_id | string | ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with `certificate_management_policy`. |
| authority | string | certificate authority to request certificates from. The only supported value is letsencrypt. |
| private_key_type | string | type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa. |
| &nbsp; | &nbsp; | &nbsp; |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| name | string | the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io. |
| domain | string | hostname of the reserved domain |
| region | string | deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) |
| description | string | human-readable description of what this reserved domain will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. |
| certificate_id | string | ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with `certificate_management_policy`. |
| authority | string | certificate authority to request certificates from. The only supported value is letsencrypt. |
| private_key_type | string | type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa. |
2 changes: 1 addition & 1 deletion docs/events/_reserved-domain-list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| description | string | human-readable description of what this reserved domain will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. |
| domain | string | hostname of the reserved domain |
| region | string | reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) |
| region | string | deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) |
| cname_target | string | DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of \*.ngrok.io |
| id | string | a resource identifier |
| uri | string | a uri for locating a resource |
Expand Down
2 changes: 1 addition & 1 deletion docs/events/_reserved-domain.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| description | string | human-readable description of what this reserved domain will be used for |
| metadata | string | arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. |
| domain | string | hostname of the reserved domain |
| region | string | reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) |
| region | string | deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) |
| cname_target | string | DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of \*.ngrok.io |
| id | string | a resource identifier |
| uri | string | a uri for locating a resource |
Expand Down
Loading

1 comment on commit 774ad23

@vercel
Copy link

@vercel vercel bot commented on 774ad23 Oct 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

ngrok-docs – ./

ngrok-docs-git-main-ngrok-dev.vercel.app
ngrok-docs.vercel.app
ngrok-docs-ngrok-dev.vercel.app

Please sign in to comment.