From 1bce04d41feaeae068e0d05a59a061b062e28275 Mon Sep 17 00:00:00 2001 From: Nuvindu Date: Tue, 17 Oct 2023 15:13:48 +0530 Subject: [PATCH 1/2] Fix syntax issue in the documentation --- README.md | 18 ++++++++++-------- ballerina/Module.md | 18 ++++++++++-------- ballerina/Package.md | 18 ++++++++++-------- ballerina/modules/soap11/Module.md | 12 +++++++----- ballerina/modules/soap12/Module.md | 12 +++++++----- 5 files changed, 44 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index f94d163..560d16b 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The `Client` is used to connect to and interact with `SOAP` endpoints. ### SOAP 1.1 Client ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -28,7 +28,7 @@ soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx? ### SOAP 1.2 Client ```ballerina -import ballerina/soap:soap12; +import ballerina/soap.soap12; soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -43,7 +43,7 @@ The SOAP 1.1 specification requires the inclusion of the `action` parameter as a ### Example: Send & Receive ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -63,7 +63,7 @@ public function main() returns error? { ### Example: Send Only ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -149,10 +149,10 @@ These policies empower SOAP clients to enhance the security of their web service import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { - soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap11:Client soapClient = check new ("https://secured-soap-endpoint.com", { inboundSecurity: [ { @@ -176,20 +176,22 @@ public function main() returns error? { } ``` +**Note**: The `https://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. + #### SOAP 1.2 Client with Asymmetric Binding and Outbound Security Configuration ```ballerina import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap12; +import ballerina/soap.soap12; public function main() returns error? { configurable crypto:PrivateKey clientPrivateKey = ?; configurable crypto:PublicKey clientPublicKey = ?; configurable ​crypto:PublicKey serverPublicKey = ?; - soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap12:Client soapClient = check new ("https://secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, diff --git a/ballerina/Module.md b/ballerina/Module.md index 5d724bc..561330f 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -11,7 +11,7 @@ The `Client` is used to connect to and interact with `SOAP` endpoints. ### SOAP 1.1 Client ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -19,7 +19,7 @@ soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx? ### SOAP 1.2 Client ```ballerina -import ballerina/soap:soap12; +import ballerina/soap.soap12; soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -34,7 +34,7 @@ The SOAP 1.1 specification requires the inclusion of the `action` parameter as a ### Example: Send & Receive ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -54,7 +54,7 @@ public function main() returns error? { ### Example: Send Only ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -139,10 +139,10 @@ These policies empower SOAP clients to enhance the security of their web service import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { - soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap11:Client soapClient = check new ("https://secured-soap-endpoint.com", { inboundSecurity: [ { @@ -166,20 +166,22 @@ public function main() returns error? { } ``` +**Note**: The `https://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. + #### SOAP 1.2 Client with Asymmetric Binding and Outbound Security Configuration ```ballerina import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap12; +import ballerina/soap.soap12; public function main() returns error? { configurable crypto:PrivateKey clientPrivateKey = ?; configurable crypto:PublicKey clientPublicKey = ?; configurable ​crypto:PublicKey serverPublicKey = ?; - soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap12:Client soapClient = check new ("https://secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, diff --git a/ballerina/Package.md b/ballerina/Package.md index f5db035..bcce677 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -11,7 +11,7 @@ The `Client` is used to connect to and interact with `SOAP` endpoints. ### SOAP 1.1 Client ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -19,7 +19,7 @@ soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx? ### SOAP 1.2 Client ```ballerina -import ballerina/soap:soap12; +import ballerina/soap.soap12; soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -34,7 +34,7 @@ The SOAP 1.1 specification requires the inclusion of the `action` parameter as a ### Example: Send & Receive ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -54,7 +54,7 @@ public function main() returns error? { ### Example: Send Only ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -139,10 +139,10 @@ These policies empower SOAP clients to enhance the security of their web service import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { - soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap11:Client soapClient = check new ("https://secured-soap-endpoint.com", { inboundSecurity: [ { @@ -166,20 +166,22 @@ public function main() returns error? { } ``` +**Note**: The `https://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. + #### SOAP 1.2 Client with Asymmetric Binding and Outbound Security Configuration ```ballerina import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap12; +import ballerina/soap.soap12; public function main() returns error? { configurable crypto:PrivateKey clientPrivateKey = ?; configurable crypto:PublicKey clientPublicKey = ?; configurable ​crypto:PublicKey serverPublicKey = ?; - soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap12:Client soapClient = check new ("https://secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, diff --git a/ballerina/modules/soap11/Module.md b/ballerina/modules/soap11/Module.md index ea56f06..4f0d008 100644 --- a/ballerina/modules/soap11/Module.md +++ b/ballerina/modules/soap11/Module.md @@ -11,7 +11,7 @@ The `Client` is used to connect to and interact with `SOAP` 1.1 endpoints. ### SOAP 1.1 Client ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -26,7 +26,7 @@ The SOAP 1.1 specification requires the inclusion of the `action` parameter as a ### Example: Send & Receive ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -46,7 +46,7 @@ public function main() returns error? { ### Example: Send Only ```ballerina -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -131,14 +131,14 @@ These policies empower SOAP clients to enhance the security of their web service import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap11; +import ballerina/soap.soap11; public function main() returns error? { crypto:PrivateKey clientPrivateKey = ...// crypto:PublicKey clientPublicKey = ...// ​​crypto:PublicKey serverPublicKey = ...// - soap11:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap11:Client soapClient = check new ("http://secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, @@ -156,6 +156,8 @@ public function main() returns error? { } ``` +**Note**: The `http://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. + ## Report issues To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina standard library parent repository](https://github.com/ballerina-platform/ballerina-standard-library). diff --git a/ballerina/modules/soap12/Module.md b/ballerina/modules/soap12/Module.md index 97751d7..5737d60 100644 --- a/ballerina/modules/soap12/Module.md +++ b/ballerina/modules/soap12/Module.md @@ -11,7 +11,7 @@ The `Client` is used to connect to and interact with `SOAP` 1.2 endpoints. ### SOAP 1.2 Client ```ballerina -import ballerina/soap:soap12; +import ballerina/soap.soap12; soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); ``` @@ -26,7 +26,7 @@ The SOAP 1.1 specification requires the inclusion of the `action` parameter as a ### Example: Send & Receive ```ballerina -import ballerina/soap:soap12; +import ballerina/soap.soap12; public function main() returns error? { soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -46,7 +46,7 @@ public function main() returns error? { ### Example: Send Only ```ballerina -import ballerina/soap:soap12; +import ballerina/soap.soap12; public function main() returns error? { soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL"); @@ -131,14 +131,14 @@ These policies empower SOAP clients to enhance the security of their web service import ballerina/crypto; import ballerina/mime; import ballerina/soap; -import ballerina/soap:soap12; +import ballerina/soap.soap12; public function main() returns error? { crypto:PrivateKey clientPrivateKey = ...// crypto:PublicKey clientPublicKey = ...// ​​crypto:PublicKey serverPublicKey = ...// - soap12:Client soapClient = check new ("http://www.dneonline.com/calculator.asmx?WSDL", + soap12:Client soapClient = check new ("http://secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, @@ -156,6 +156,8 @@ public function main() returns error? { } ``` +**Note**: The `http://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. + ## Report issues To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina standard library parent repository](https://github.com/ballerina-platform/ballerina-standard-library). From b2ccc17ce220d8b9bc7d5112d5e13cfad9507128 Mon Sep 17 00:00:00 2001 From: Nuvindu Date: Tue, 17 Oct 2023 15:36:58 +0530 Subject: [PATCH 2/2] Fix subdomain of the url in the doc --- README.md | 6 ++---- ballerina/Module.md | 6 ++---- ballerina/Package.md | 6 ++---- ballerina/modules/soap11/Module.md | 4 +--- ballerina/modules/soap12/Module.md | 4 +--- 5 files changed, 8 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 560d16b..2214ffd 100644 --- a/README.md +++ b/README.md @@ -152,7 +152,7 @@ import ballerina/soap; import ballerina/soap.soap11; public function main() returns error? { - soap11:Client soapClient = check new ("https://secured-soap-endpoint.com", + soap11:Client soapClient = check new ("https://www.secured-soap-endpoint.com", { inboundSecurity: [ { @@ -176,8 +176,6 @@ public function main() returns error? { } ``` -**Note**: The `https://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. - #### SOAP 1.2 Client with Asymmetric Binding and Outbound Security Configuration ```ballerina @@ -191,7 +189,7 @@ public function main() returns error? { configurable crypto:PublicKey clientPublicKey = ?; configurable ​crypto:PublicKey serverPublicKey = ?; - soap12:Client soapClient = check new ("https://secured-soap-endpoint.com", + soap12:Client soapClient = check new ("https://www.secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, diff --git a/ballerina/Module.md b/ballerina/Module.md index 561330f..3da335a 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -142,7 +142,7 @@ import ballerina/soap; import ballerina/soap.soap11; public function main() returns error? { - soap11:Client soapClient = check new ("https://secured-soap-endpoint.com", + soap11:Client soapClient = check new ("https://www.secured-soap-endpoint.com", { inboundSecurity: [ { @@ -166,8 +166,6 @@ public function main() returns error? { } ``` -**Note**: The `https://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. - #### SOAP 1.2 Client with Asymmetric Binding and Outbound Security Configuration ```ballerina @@ -181,7 +179,7 @@ public function main() returns error? { configurable crypto:PublicKey clientPublicKey = ?; configurable ​crypto:PublicKey serverPublicKey = ?; - soap12:Client soapClient = check new ("https://secured-soap-endpoint.com", + soap12:Client soapClient = check new ("https://www.secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, diff --git a/ballerina/Package.md b/ballerina/Package.md index bcce677..685dae7 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -142,7 +142,7 @@ import ballerina/soap; import ballerina/soap.soap11; public function main() returns error? { - soap11:Client soapClient = check new ("https://secured-soap-endpoint.com", + soap11:Client soapClient = check new ("https://www.secured-soap-endpoint.com", { inboundSecurity: [ { @@ -166,8 +166,6 @@ public function main() returns error? { } ``` -**Note**: The `https://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. - #### SOAP 1.2 Client with Asymmetric Binding and Outbound Security Configuration ```ballerina @@ -181,7 +179,7 @@ public function main() returns error? { configurable crypto:PublicKey clientPublicKey = ?; configurable ​crypto:PublicKey serverPublicKey = ?; - soap12:Client soapClient = check new ("https://secured-soap-endpoint.com", + soap12:Client soapClient = check new ("https://www.secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, diff --git a/ballerina/modules/soap11/Module.md b/ballerina/modules/soap11/Module.md index 4f0d008..22ffc54 100644 --- a/ballerina/modules/soap11/Module.md +++ b/ballerina/modules/soap11/Module.md @@ -138,7 +138,7 @@ public function main() returns error? { crypto:PublicKey clientPublicKey = ...// ​​crypto:PublicKey serverPublicKey = ...// - soap11:Client soapClient = check new ("http://secured-soap-endpoint.com", + soap11:Client soapClient = check new ("http://www.secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, @@ -156,8 +156,6 @@ public function main() returns error? { } ``` -**Note**: The `http://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. - ## Report issues To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina standard library parent repository](https://github.com/ballerina-platform/ballerina-standard-library). diff --git a/ballerina/modules/soap12/Module.md b/ballerina/modules/soap12/Module.md index 5737d60..e3b4388 100644 --- a/ballerina/modules/soap12/Module.md +++ b/ballerina/modules/soap12/Module.md @@ -138,7 +138,7 @@ public function main() returns error? { crypto:PublicKey clientPublicKey = ...// ​​crypto:PublicKey serverPublicKey = ...// - soap12:Client soapClient = check new ("http://secured-soap-endpoint.com", + soap12:Client soapClient = check new ("http://www.secured-soap-endpoint.com", { inboundSecurity: { signatureAlgorithm: soap:RSA_SHA256, @@ -156,8 +156,6 @@ public function main() returns error? { } ``` -**Note**: The `http://secured-soap-endpoint.com` URL represents an endpoint for a SOAP server equipped to handle web service security. Please be aware that this URL is provided for illustrative purposes and does not correspond to an actual live server. - ## Report issues To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina standard library parent repository](https://github.com/ballerina-platform/ballerina-standard-library).