-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a768d78
commit 24f0fb9
Showing
16 changed files
with
2,280 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| # Swagger\Client\TextInputApi | ||
|
|
||
| All URIs are relative to *https://api.cloudmersive.com* | ||
|
|
||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| [**textInputCheckXss**](TextInputApi.md#textInputCheckXss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks | ||
| [**textInputProtectXss**](TextInputApi.md#textInputProtectXss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization | ||
|
|
||
|
|
||
| # **textInputCheckXss** | ||
| > \Swagger\Client\Model\XssProtectionResult textInputCheckXss($value) | ||
| Check text input for Cross-Site-Scripting (XSS) attacks | ||
|
|
||
| Detects XSS (Cross-Site-Scripting) attacks from text input. | ||
|
|
||
| ### Example | ||
| ```php | ||
| <?php | ||
| require_once(__DIR__ . '/vendor/autoload.php'); | ||
|
|
||
| // Configure API key authorization: Apikey | ||
| $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY'); | ||
| // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed | ||
| // $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); | ||
|
|
||
| $apiInstance = new Swagger\Client\Api\TextInputApi( | ||
| // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. | ||
| // This is optional, `GuzzleHttp\Client` will be used as default. | ||
| new GuzzleHttp\Client(), | ||
| $config | ||
| ); | ||
| $value = "value_example"; // string | User-facing text input. | ||
|
|
||
| try { | ||
| $result = $apiInstance->textInputCheckXss($value); | ||
| print_r($result); | ||
| } catch (Exception $e) { | ||
| echo 'Exception when calling TextInputApi->textInputCheckXss: ', $e->getMessage(), PHP_EOL; | ||
| } | ||
| ?> | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **value** | **string**| User-facing text input. | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**\Swagger\Client\Model\XssProtectionResult**](../Model/XssProtectionResult.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [Apikey](../../README.md#Apikey) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: text/javascript, application/json, text/json | ||
| - **Accept**: application/json, text/json, application/xml, text/xml | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) | ||
|
|
||
| # **textInputProtectXss** | ||
| > \Swagger\Client\Model\XssProtectionResult textInputProtectXss($value) | ||
| Protect text input from Cross-Site-Scripting (XSS) attacks through normalization | ||
|
|
||
| Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization. Returns the normalized result, as well as information on whether the original input contained an XSS risk. | ||
|
|
||
| ### Example | ||
| ```php | ||
| <?php | ||
| require_once(__DIR__ . '/vendor/autoload.php'); | ||
|
|
||
| // Configure API key authorization: Apikey | ||
| $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY'); | ||
| // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed | ||
| // $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); | ||
|
|
||
| $apiInstance = new Swagger\Client\Api\TextInputApi( | ||
| // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. | ||
| // This is optional, `GuzzleHttp\Client` will be used as default. | ||
| new GuzzleHttp\Client(), | ||
| $config | ||
| ); | ||
| $value = "value_example"; // string | User-facing text input. | ||
|
|
||
| try { | ||
| $result = $apiInstance->textInputProtectXss($value); | ||
| print_r($result); | ||
| } catch (Exception $e) { | ||
| echo 'Exception when calling TextInputApi->textInputProtectXss: ', $e->getMessage(), PHP_EOL; | ||
| } | ||
| ?> | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **value** | **string**| User-facing text input. | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**\Swagger\Client\Model\XssProtectionResult**](../Model/XssProtectionResult.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [Apikey](../../README.md#Apikey) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: text/javascript, application/json, text/json | ||
| - **Accept**: application/json, text/json, application/xml, text/xml | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # GeolocateStreetAddressResponse | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **country_code** | **string** | Two-letter country code of IP address | [optional] | ||
| **country_name** | **string** | Country name of IP address | [optional] | ||
| **street_address** | **string** | Street address of IP address | [optional] | ||
| **city** | **string** | City of IP address | [optional] | ||
| **region_name** | **string** | State/region of IP address | [optional] | ||
| **zip_code** | **string** | Zip or postal code of IP address | [optional] | ||
|
|
||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # XssProtectionResult | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **successful** | **bool** | True if the operation was successful, false otherwise | [optional] | ||
| **contained_xss** | **bool** | True if the input contained XSS scripting, false otherwise | [optional] | ||
| **original_input** | **string** | Original input string | [optional] | ||
| **normalized_result** | **string** | Normalized string result, with XSS removed | [optional] | ||
|
|
||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
Oops, something went wrong.