mj/php-ovh
1
0
Fork 0
mirror of https://github.com/ovh/php-ovh.git synced 2023-11-05 03:20:26 +01:00
Code Issues Releases Wiki Activity

Merge pull request #128 from Benjamin-Loison/master

Browse Source 
Fix typos in `README.md` and `CONTRIBUTING.rst`
This commit is contained in:
Adrien Barreau 2023-05-31 10:16:36 +02:00 committed by GitHub
commit 096a7b7413
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.rst
View File

@ -32,7 +32,7 @@ It can be accessed online too:
https://www.kernel.org/doc/Documentation/SubmittingPatches https://www.kernel.org/doc/Documentation/SubmittingPatches
You can submit your patches via GitHub You can submit your patches via GitHub.
Licensing for new files: Licensing for new files:
------------------------ ------------------------

14
README.md
View File

@ -15,7 +15,7 @@ Compatible with PHP 7.4, 8.0, 8.1, 8.2.
## Installation ## Installation
Install this wrapper and integrate it inside your PHP application with [Composer](https://getcomposer.org) : Install this wrapper and integrate it inside your PHP application with [Composer](https://getcomposer.org):
composer require ovh/ovh composer require ovh/ovh
@ -26,7 +26,7 @@ Install this wrapper and integrate it inside your PHP application with [Composer
require __DIR__ . '/vendor/autoload.php'; require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api; use \Ovh\Api;
// Api credentials can be retreived from the urls specified in the "Supported endpoints" section below. // Api credentials can be retrieved from the urls specified in the "Supported endpoints" section below.
$ovh = new Api($applicationKey, $ovh = new Api($applicationKey,
$applicationSecret, $applicationSecret,
$endpoint, $endpoint,
@ -71,7 +71,7 @@ $client = new Client();
$client->setDefaultOption('timeout', 1); $client->setDefaultOption('timeout', 1);
$client->setDefaultOption('headers', ['User-Agent' => 'api_client']); $client->setDefaultOption('headers', ['User-Agent' => 'api_client']);
// Api credentials can be retreived from the urls specified in the "Supported endpoints" section below. // Api credentials can be retrieved from the urls specified in the "Supported endpoints" section below.
// Inject the custom HTTP client as the 5th argument of the constructor // Inject the custom HTTP client as the 5th argument of the constructor
$ovh = new Api($applicationKey, $ovh = new Api($applicationKey,
$applicationSecret, $applicationSecret,
@ -94,7 +94,7 @@ See "OVHcloud API authentication" section below for more information about the a
use \Ovh\Api; use \Ovh\Api;
session_start(); session_start();
// Api credentials can be retreived from the urls specified in the "Supported endpoints" section below. // Api credentials can be retrieved from the urls specified in the "Supported endpoints" section below.
$ovh = new Api($applicationKey, $ovh = new Api($applicationKey,
$applicationSecret, $applicationSecret,
$endpoint); $endpoint);
@ -115,7 +115,7 @@ header('location: '. $credentials['validationUrl']);
// After successful redirect, the consumerKey in the session will be activated and you will be able to use it to make API requests like in the "Basic usage" section above. // After successful redirect, the consumerKey in the session will be activated and you will be able to use it to make API requests like in the "Basic usage" section above.
``` ```
### Code sample : Enable network burst on GRA1 dedicated servers ### Code sample: Enable network burst on GRA1 dedicated servers
Here is a more complex example of how to use the wrapper to enable network burst on GRA1 dedicated servers. Here is a more complex example of how to use the wrapper to enable network burst on GRA1 dedicated servers.
@ -124,7 +124,7 @@ Here is a more complex example of how to use the wrapper to enable network burst
require __DIR__ . '/vendor/autoload.php'; require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api; use \Ovh\Api;
// Api credentials can be retreived from the urls specified in the "Supported endpoints" section below. // Api credentials can be retrieved from the urls specified in the "Supported endpoints" section below.
$ovh = new Api($applicationKey, $ovh = new Api($applicationKey,
$applicationSecret, $applicationSecret,
$endpoint, $endpoint,
@ -151,7 +151,7 @@ Do you want to use OVH APIs? Maybe the script you want is already written in the
## OVHcloud API authentication ## OVHcloud API authentication
To use the OVHcloud APIs you need three credentials : To use the OVHcloud APIs you need three credentials:
* An application key * An application key
* An application secret * An application secret