Skip to content

Commit

Permalink
Fix line length
Browse files Browse the repository at this point in the history
  • Loading branch information
ldclakmal committed Jan 21, 2021
1 parent f841cf4 commit 74f941f
Show file tree
Hide file tree
Showing 23 changed files with 50 additions and 50 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import ballerina/log;

// Defines the HTTP client to call the Basic auth secured APIs.
// The client is enriched with the `Authorization: Basic <token>` header by
// passing the `http:CredentialsConfig` for the `auth` configuration
// of the client.
// passing the `http:CredentialsConfig` for the `auth` configuration of the
// client.
http:Client securedEP = checkpanic new("https://localhost:9090", {
auth: {
username: "alice",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// A client, which is secured with Basic auth can be used to connect to
// a secured service.<br/>
// The client is enriched with the `Authorization: Basic <token>` header by
// passing the `http:CredentialsConfig` for the `auth` configuration
// of the client.<br/><br/>
// For more information on the underlying module,
// passing the `http:CredentialsConfig` for the `auth` configuration of the
// client.<br/><br/>
// For more information on the underlying module,
// see the [Auth module](https://ballerina.io/swan-lake/learn/api-docs/ballerina/#/ballerina/auth/latest/auth/).
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Before testing this sample, first start a sample service secured with Basic Auth.
# To run this sample, navigate to the directory that contains the `.bal` file,
# and execute the `bal run` command below.
# (You may need to change the keystore path, a sample keystore file is
# (You may need to change the keystore path. A sample keystore file is
# available in the distribution.
# The file path is <ballerina.home>/examples/resources/ballerinaKeystore.p12)
bal run secured_client_with_basic_auth.bal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import ballerina/log;

// Defines the HTTP client to call the secured APIs.
// The client is enriched with the `Authorization: Bearer <token>` header by
// passing the `http:BearerTokenConfig` for the `auth` configuration
// of the client.
// passing the `http:BearerTokenConfig` for the `auth` configuration of the
// client.
http:Client securedEP = checkpanic new("https://localhost:9090", {
auth: {
token: "JlbmMiOiJBMTI4Q0JDLUhTMjU2In"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// A client, which is secured with Bearer token auth can be used to connect to
// a secured service.<br/>
// The client is enriched with the `Authorization: Bearer <token>` header by
// passing the `http:BearerTokenConfig` for the `auth` configuration
// of the client.
// passing the `http:BearerTokenConfig` for the `auth` configuration of the
// client.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Before testing this sample, first start a secured sample service.
# To run this sample, navigate to the directory that contains the `.bal` file,
# and execute the `bal run` command below.
# (You may need to change the keystore path, a sample keystore file is
# (You may need to change the keystore path. A sample keystore file is
# available in the distribution.
# The file path is <ballerina.home>/examples/resources/ballerinaKeystore.p12)
bal run secured_client_with_bearer_token_auth.bal
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Before testing this sample, first start a sample service secured with OAuth2.
# To run this sample, navigate to the directory that contains the `.bal` file,
# and execute the `bal run` command below.
# (You may need to change the keystore path, a sample keystore file is
# (You may need to change the keystore path. A sample keystore file is
# available in the distribution.
# The file path is <ballerina.home>/examples/resources/ballerinaKeystore.p12)
bal run secured_client_with_oauth2_password_grant_type.bal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import ballerina/log;

// Defines the HTTP client to call the OAuth2 secured APIs.
// The client is enriched with the `Authorization: Bearer <token>` header by
// passing the `http:DirectTokenConfig` for the `auth` configuration
// of the client.
// passing the `http:DirectTokenConfig` for the `auth` configuration of the
// client.
http:Client securedEP = checkpanic new("https://localhost:9090", {
auth: {
refreshUrl: "https://localhost:9090/oauth2/token/refresh",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// A client, which is secured with an OAuth2 direct token type
// can be used to connect to a secured service.<br/>
// A client, which is secured with an OAuth2 direct token type can be used to
// connect to a secured service.<br/>
// The client is enriched with the `Authorization: Bearer <token>` header by
// passing the `http:OAuth2DirectTokenConfig` to the `auth`
// configuration of the client.<br/><br/>
// passing the `http:OAuth2DirectTokenConfig` to the `auth` configuration of
// the client.<br/><br/>
// For more information on the underlying module,
// see the [OAuth2 module](https://ballerina.io/swan-lake/learn/api-docs/ballerina/#/ballerina/oauth2/latest/oauth2/).
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Before test this sample, first start a sample service secured with OAuth2.
# To run this sample, navigate to the directory that contains the `.bal` file,
# and execute the `bal run` command below.
# (You may need to change the keystore path, a sample keystore file is
# (You may need to change the keystore path. A sample keystore file is
# available in the distribution.
# The file path is <ballerina.home>/examples/resources/ballerinaKeystore.p12)
bal run secured_client_with_oauth2_password_grant_type.bal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import ballerina/log;

// Defines the HTTP client to call the OAuth2 secured APIs.
// The client is enriched with the `Authorization: Bearer <token>` header by
// passing the `http:PasswordGrantConfig` to the `auth` configuration
// of the client.
// passing the `http:PasswordGrantConfig` to the `auth` configuration of the
// client.
http:Client securedEP = checkpanic new("https://localhost:9090", {
auth: {
tokenUrl: "https://localhost:9090/oauth2/token",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// A client, which is secured with OAuth2 password grant type
// can be used to connect to a secured service.<br/>
// A client, which is secured with OAuth2 password grant type can be used to
// connect to a secured service.<br/>
// The client is enriched with the `Authorization: Bearer <token>` header by
// passing the `http:OAuth2PasswordGrantConfig` to the `auth`
// configuration of the client.<br/><br/>
// passing the `http:OAuth2PasswordGrantConfig` to the `auth` configuration of
// the client.<br/><br/>
// For more information on the underlying module,
// see the [OAuth2 module](https://ballerina.io/swan-lake/learn/api-docs/ballerina/#/ballerina/oauth2/latest/oauth2/).
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import ballerina/log;

// Defines the HTTP client to call the JWT auth secured APIs.
// The client is enriched with the `Authorization: Bearer <token>` header by
// passing the `http:JwtIssuerConfig` for the `auth` configuration
// of the client. A self signed JWT is issued before the request is sent.
// passing the `http:JwtIssuerConfig` for the `auth` configuration of the
// client. A self signed JWT is issued before the request is sent.
http:Client securedEP = checkpanic new("https://localhost:9090", {
auth: {
username: "wso2",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
// }
//});
//
//// The service can be secured with Basic auth and can be
//// authorized optionally. Using Basic auth with the file user store can be enabled by setting
//// the `http:FileUserStoreConfig` configurations.
//// The service can be secured with Basic auth and can be authorized optionally.
//// Using Basic auth with the file user store can be enabled by setting the
//// `http:FileUserStoreConfig` configurations.
//// Authorization is based on scopes. A scope maps to one or more groups.
//// Authorization can be enabled by setting the `string|string[]` type
//// configurations.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// An HTTP service/resource can be secured using Basic auth and optionally by
// enforcing authorization. Then, it validates the Basic auth token sent in the
// `Authorization` header against the provided configurations. This reads data
// from a file, which has a TOML format. This stores the usernames, passwords for
// authentication, and scopes for authorization.<br/>
// from a file, which has a TOML format. This stores the usernames, passwords
// for authentication, and scopes for authorization.<br/>
// Ballerina uses the concept of scopes for authorization. A resource declared
// in a service can be bound to one/more scope(s).<br/>
// In the authorization phase, the scopes of the service/resource are compared
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ listener http:Listener securedEP = new(9090, config = {
}
});

// The service can be secured with Basic auth and can be
// authorized optionally. Basic auth using the LDAP user store can be enabled by setting
// the `http:LdapUserStoreConfig` configurations.
// The service can be secured with Basic auth and can be authorized optionally.
// Basic auth using the LDAP user store can be enabled by setting the
// `http:LdapUserStoreConfig` configurations.
// Authorization is based on scopes. A scope maps to one or more groups.
// Authorization can be enabled by setting the `string|string[]` type
// configurations.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// An HTTP service/resource can be secured using Basic auth and by
// enforcing authorization optionally. Then, it validates the Basic auth token sent in the
// `Authorization` header against the provided configurations. This reads data
// from the configured LDAP. This stores usernames, passwords for
// An HTTP service/resource can be secured using Basic auth and by enforcing
// authorization optionally. Then, it validates the Basic auth token sent in
// the `Authorization` header against the provided configurations. This reads
// data from the configured LDAP. This stores usernames, passwords for
// authentication, and scopes for authorization.<br/>
// Ballerina uses the concept of scopes for authorization. A resource declared
// in a service can be bound to one/more scope(s).<br/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# To run this sample, navigate to the directory that contains the `.bal` file,
# and execute the `bal run` command below.
# (You may need to change the keystore path, a sample keystore file is
# (You may need to change the keystore path. A sample keystore file is
# available in the distribution.
# The file path is <ballerina.home>/examples/resources/ballerinaKeystore.p12)
bal run secured_service_with_basic_auth_ldap_user_store.bal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ listener http:Listener securedEP = new(9090, config = {
}
});

// The service can be secured with JWT authentication and can be
// authorized optionally. JWT authentication can be enabled by setting the
// The service can be secured with JWT authentication and can be authorized
// optionally. JWT authentication can be enabled by setting the
// `http:JwtValidatorConfig` configurations.
// Authorization is based on scopes. A scope maps to one or more groups.
// Authorization can be enabled by setting the `string|string[]` type
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// An HTTP service/resource can be secured using JWT and by enforcing
// authorization optionally. Then, it validates the JWT sent in the `Authorization` header
// against the provided configurations.<br/>
// authorization optionally. Then, it validates the JWT sent in the
// `Authorization` header against the provided configurations.<br/>
// Ballerina uses the concept of scopes for authorization. A resource declared
// in a service can be bound to one/more scope(s). The scope can be included
// in the JWT using a custom claim attribute. That custom claim attribute
// in the JWT using a custom claim attribute. That custom claim attribute
// also can be configured as the `scopeKey`.<br/>
// In the authorization phase, the scopes of the service/resource are compared
// against the scope included in the JWT for at least one match between the two
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ listener http:Listener securedEP = new(9090, config = {
}
});

// The service can be secured with OAuth2 authentication and can be
// authorized optionally. OAuth2 authentication can be enabled by setting the
// The service can be secured with OAuth2 authentication and can be authorized
// optionally. OAuth2 authentication can be enabled by setting the
// `http:OAuth2IntrospectionConfig` configurations.
// Authorization is based on scopes. A scope maps to one or more groups.
// Authorization can be enabled by setting the `string|string[]` type
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// An HTTP service/resource can be secured using OAuth2 and by
// enforcing authorization optionally. Then, it validates the OAuth2 token sent in the
// An HTTP service/resource can be secured using OAuth2 and by enforcing
// authorization optionally. Then, it validates the OAuth2 token sent in the
// `Authorization` header against the provided configurations. This calls the
// configured introspection endpoint to validate.<br/>
// Ballerina uses the concept of scopes for authorization. A resource declared
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# To run this sample, navigate to the directory that contains the `.bal` file,
# and execute the `bal run` command below.
# (You may need to change the keystore path, a sample keystore file is
# (You may need to change the keystore path. A sample keystore file is
# available in the distribution.
# The file path is <ballerina.home>/examples/resources/ballerinaKeystore.p12)
bal run secured_service_with_oauth2.bal
Expand Down

0 comments on commit 74f941f

Please sign in to comment.