-

ngrok Java API client 0.3.0 API

+

ngrok Java API client 0.4.0 API

Packages
diff --git a/docs/overview-summary.html b/docs/overview-summary.html index f8a9fd2..5dc2321 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -1,11 +1,11 @@ - -ngrok Java API client 0.3.0 API + +ngrok Java API client 0.4.0 API - + diff --git a/docs/overview-tree.html b/docs/overview-tree.html index 0fcded2..c5d2666 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -1,11 +1,11 @@ - -Class Hierarchy (ngrok Java API client 0.3.0 API) + +Class Hierarchy (ngrok Java API client 0.4.0 API) - + diff --git a/docs/serialized-form.html b/docs/serialized-form.html index 5957b87..4400254 100644 --- a/docs/serialized-form.html +++ b/docs/serialized-form.html @@ -1,11 +1,11 @@ - -Serialized Form (ngrok Java API client 0.3.0 API) + +Serialized Form (ngrok Java API client 0.4.0 API) - + diff --git a/pom.xml b/pom.xml index da27751..1fe0177 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ com.ngrok ngrok-api-java - 0.3.1-SNAPSHOT + 0.4.1-SNAPSHOT ngrok Java API client ngrok API client for Java applications diff --git a/src/main/java/com/ngrok/definitions/Credential.java b/src/main/java/com/ngrok/definitions/Credential.java index 896e71a..bf5087f 100644 --- a/src/main/java/com/ngrok/definitions/Credential.java +++ b/src/main/java/com/ngrok/definitions/Credential.java @@ -43,7 +43,7 @@ public class Credential { * @param createdAt timestamp when the tunnel credential was created, RFC 3339 format * @param description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes. * @param metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes. - * @param token the credential's authtoken that can be used to authenticate an ngrok client. This value is only available one time, on the API response from credential creation, otherwise it is null. + * @param token the credential's authtoken that can be used to authenticate an ngrok agent. This value is only available one time, on the API response from credential creation, otherwise it is null. * @param acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions. */ @JsonCreator @@ -113,7 +113,7 @@ public class Credential { } /** - * the credential's authtoken that can be used to authenticate an ngrok client. + * the credential's authtoken that can be used to authenticate an ngrok agent. * This value is only available one time, on the API response from * credential creation, otherwise it is null. * diff --git a/src/main/java/com/ngrok/definitions/EndpointMutualTlsMutate.java b/src/main/java/com/ngrok/definitions/EndpointMutualTlsMutate.java index ff38f0a..f539edf 100644 --- a/src/main/java/com/ngrok/definitions/EndpointMutualTlsMutate.java +++ b/src/main/java/com/ngrok/definitions/EndpointMutualTlsMutate.java @@ -50,7 +50,7 @@ public class EndpointMutualTlsMutate { /** * list of certificate authorities that will be used to validate the TLS client - * certificate presnted by the initiatiator of the TLS connection + * certificate presented by the initiator of the TLS connection * * @param certificateAuthorityIds the value of the certificate_authority_ids parameter as a {@link java.util.List} * @return this builder instance @@ -62,7 +62,7 @@ public class EndpointMutualTlsMutate { /** * list of certificate authorities that will be used to validate the TLS client - * certificate presnted by the initiatiator of the TLS connection + * certificate presented by the initiator of the TLS connection * * @param certificateAuthorityIds the value of the certificate_authority_ids parameter as a {@link java.util.List}, wrapped in an {@link Optional} * @return this builder instance @@ -107,7 +107,7 @@ public class EndpointMutualTlsMutate { * Creates a new instance of {@link EndpointMutualTlsMutate}. * * @param enabled true if the module will be applied to traffic, false to disable. default true if unspecified - * @param certificateAuthorityIds list of certificate authorities that will be used to validate the TLS client certificate presnted by the initiatiator of the TLS connection + * @param certificateAuthorityIds list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection */ @JsonCreator private EndpointMutualTlsMutate( @@ -130,7 +130,7 @@ public class EndpointMutualTlsMutate { /** * list of certificate authorities that will be used to validate the TLS client - * certificate presnted by the initiatiator of the TLS connection + * certificate presented by the initiator of the TLS connection * * @return the value of the property as a {@link java.util.List} */ diff --git a/src/main/java/com/ngrok/definitions/IpRestrictionList.java b/src/main/java/com/ngrok/definitions/IpRestrictionList.java index 591978a..5362f94 100644 --- a/src/main/java/com/ngrok/definitions/IpRestrictionList.java +++ b/src/main/java/com/ngrok/definitions/IpRestrictionList.java @@ -27,7 +27,7 @@ public class IpRestrictionList implements Pageable { * Creates a new instance of {@link IpRestrictionList}. * * @param ipRestrictions the list of all IP restrictions on this account - * @param uri URI of the IP resrtrictions list API resource + * @param uri URI of the IP restrictions list API resource * @param nextPageUri URI of the next page, or null if there is no next page */ @JsonCreator @@ -51,7 +51,7 @@ public class IpRestrictionList implements Pageable { } /** - * URI of the IP resrtrictions list API resource + * URI of the IP restrictions list API resource * * @return the value of the property as a {@link java.net.URI} */ diff --git a/src/main/java/com/ngrok/definitions/SshUserCertificate.java b/src/main/java/com/ngrok/definitions/SshUserCertificate.java index 75d3bad..206913c 100644 --- a/src/main/java/com/ngrok/definitions/SshUserCertificate.java +++ b/src/main/java/com/ngrok/definitions/SshUserCertificate.java @@ -67,7 +67,7 @@ public class SshUserCertificate { * @param publicKey a public key in OpenSSH Authorized Keys format that this certificate signs * @param keyType the key type of the public_key, one of rsa, ecdsa or ed25519 * @param sshCertificateAuthorityId the ssh certificate authority that is used to sign this ssh user certificate - * @param principals the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user. + * @param principals the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user. * @param criticalOptions A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details. * @param extensions A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details. * @param validAfter the time when the ssh host certificate becomes valid, in RFC 3339 format. @@ -185,7 +185,7 @@ public class SshUserCertificate { /** * the list of principals included in the ssh user certificate. This is the list of - * usernames that the certificate holder may sign in as on a machine authorizinig + * usernames that the certificate holder may sign in as on a machine authorizing * the signing certificate authority. Dangerously, if no principals are specified, * this certificate may be used to log in as any user. * diff --git a/src/main/java/com/ngrok/definitions/WeightedBackend.java b/src/main/java/com/ngrok/definitions/WeightedBackend.java index 8973692..88e4d66 100644 --- a/src/main/java/com/ngrok/definitions/WeightedBackend.java +++ b/src/main/java/com/ngrok/definitions/WeightedBackend.java @@ -40,7 +40,7 @@ public class WeightedBackend { * @param createdAt timestamp when the backend was created, RFC 3339 format * @param description human-readable description of this backend. Optional * @param metadata arbitrary user-defined machine-readable data of this backend. Optional - * @param backends the ids of the child backends to their weights (0-10000) + * @param backends the ids of the child backends to their weights [0-10000] */ @JsonCreator public WeightedBackend( @@ -105,7 +105,7 @@ public class WeightedBackend { } /** - * the ids of the child backends to their weights (0-10000) + * the ids of the child backends to their weights [0-10000] * * @return the value of the property as a {@link java.util.Map} */ diff --git a/src/main/java/com/ngrok/services/FailoverBackends.java b/src/main/java/com/ngrok/services/FailoverBackends.java index ba1a02d..89d07a3 100644 --- a/src/main/java/com/ngrok/services/FailoverBackends.java +++ b/src/main/java/com/ngrok/services/FailoverBackends.java @@ -198,7 +198,7 @@ public class FailoverBackends { } /** - * Delete a Failover backend by ID. TODO what if used? + * Delete a Failover backend by ID. * * See also https://ngrok.com/docs/api#api-failover-backends-delete. * diff --git a/src/main/java/com/ngrok/services/SshUserCertificates.java b/src/main/java/com/ngrok/services/SshUserCertificates.java index dccf750..02edccd 100644 --- a/src/main/java/com/ngrok/services/SshUserCertificates.java +++ b/src/main/java/com/ngrok/services/SshUserCertificates.java @@ -54,7 +54,7 @@ public class SshUserCertificates { /** * the list of principals included in the ssh user certificate. This is the list of - * usernames that the certificate holder may sign in as on a machine authorizinig + * usernames that the certificate holder may sign in as on a machine authorizing * the signing certificate authority. Dangerously, if no principals are specified, * this certificate may be used to log in as any user. * @@ -68,7 +68,7 @@ public class SshUserCertificates { /** * the list of principals included in the ssh user certificate. This is the list of - * usernames that the certificate holder may sign in as on a machine authorizinig + * usernames that the certificate holder may sign in as on a machine authorizing * the signing certificate authority. Dangerously, if no principals are specified, * this certificate may be used to log in as any user. * diff --git a/src/main/java/com/ngrok/services/TunnelGroupBackends.java b/src/main/java/com/ngrok/services/TunnelGroupBackends.java index 403b0a1..d6f5dd8 100644 --- a/src/main/java/com/ngrok/services/TunnelGroupBackends.java +++ b/src/main/java/com/ngrok/services/TunnelGroupBackends.java @@ -196,7 +196,7 @@ public class TunnelGroupBackends { } /** - * Delete a TunnelGroup backend by ID. TODO what if used? + * Delete a TunnelGroup backend by ID. * * See also https://ngrok.com/docs/api#api-tunnel-group-backends-delete. * diff --git a/src/main/java/com/ngrok/services/WeightedBackends.java b/src/main/java/com/ngrok/services/WeightedBackends.java index f64a7fe..2d705ab 100644 --- a/src/main/java/com/ngrok/services/WeightedBackends.java +++ b/src/main/java/com/ngrok/services/WeightedBackends.java @@ -88,7 +88,7 @@ public class WeightedBackends { } /** - * the ids of the child backends to their weights (0-10000) + * the ids of the child backends to their weights [0-10000] * * @param backends the value of the backends parameter as a {@link java.util.Map} * @return the call builder instance @@ -99,7 +99,7 @@ public class WeightedBackends { } /** - * the ids of the child backends to their weights (0-10000) + * the ids of the child backends to their weights [0-10000] * * @param backends the value of the backends parameter as an {@link Optional} of {@link java.util.Map} * @return the call builder instance @@ -198,7 +198,7 @@ public class WeightedBackends { } /** - * Delete a Weighted backend by ID. TODO what if used? + * Delete a Weighted backend by ID. * * See also https://ngrok.com/docs/api#api-weighted-backends-delete. * @@ -432,7 +432,7 @@ public class WeightedBackends { } /** - * the ids of the child backends to their weights (0-10000) + * the ids of the child backends to their weights [0-10000] * * @param backends the value of the backends parameter as a {@link java.util.Map} * @return the call builder instance @@ -443,7 +443,7 @@ public class WeightedBackends { } /** - * the ids of the child backends to their weights (0-10000) + * the ids of the child backends to their weights [0-10000] * * @param backends the value of the backends parameter as an {@link Optional} of {@link java.util.Map} * @return the call builder instance