rose-nielsen-sdk 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +19 -19
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a67d73b5831eea8d43e61752d9e591d2a9351cd2c9386885b1110346989d21ec
|
4
|
+
data.tar.gz: c70a31f43e9114a28cfd0818c4f40484b417f19a21980860f7fee4b4675a5f97
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 782c617f9df736c9863c045ef2e7c6215ce5ef6613f3a22e26e8c663f33dbbe278fc64fb447e028c7475e6c851b4734fcc63c223cedf3b50b1f0d5d349fcc344
|
7
|
+
data.tar.gz: 6b35f54c8da14e6ad4ed2c8445cda1ccacb26f0bcaf1cad65b7c6a1fd926a296e1a2da939ea88021e381bddd1e7866ad5ed8f9c0b1562e00dcc9b037e4afac05
|
data/README.md
CHANGED
@@ -12,16 +12,16 @@ Find out more about Swagger: [http://swagger.io](http://swagger.io)
|
|
12
12
|
Install the gem from the command line:
|
13
13
|
|
14
14
|
```bash
|
15
|
-
gem install rose-nielsen-sdk -v 0.1.
|
15
|
+
gem install rose-nielsen-sdk -v 0.1.5
|
16
16
|
```
|
17
17
|
|
18
18
|
Or add the gem to your Gemfile and run `bundle`:
|
19
19
|
|
20
20
|
```ruby
|
21
|
-
gem 'rose-nielsen-sdk', '0.1.
|
21
|
+
gem 'rose-nielsen-sdk', '0.1.5'
|
22
22
|
```
|
23
23
|
|
24
|
-
For additional gem details, see the [RubyGems page for the rose-nielsen-sdk gem](https://rubygems.org/gems/rose-nielsen-sdk/versions/0.1.
|
24
|
+
For additional gem details, see the [RubyGems page for the rose-nielsen-sdk gem](https://rubygems.org/gems/rose-nielsen-sdk/versions/0.1.5).
|
25
25
|
|
26
26
|
## Test the SDK
|
27
27
|
|
@@ -33,7 +33,7 @@ rake
|
|
33
33
|
|
34
34
|
## Initialize the API Client
|
35
35
|
|
36
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
36
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/client.md)
|
37
37
|
|
38
38
|
The following parameters are configurable for the API Client:
|
39
39
|
|
@@ -50,10 +50,10 @@ The following parameters are configurable for the API Client:
|
|
50
50
|
| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
51
51
|
| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
52
52
|
| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
53
|
-
| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
54
|
-
| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
55
|
-
| http_basic_credentials | [`HttpBasicCredentials`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
56
|
-
| petstore_auth_credentials | [`PetstoreAuthCredentials`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
53
|
+
| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
|
54
|
+
| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
|
55
|
+
| http_basic_credentials | [`HttpBasicCredentials`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
|
56
|
+
| petstore_auth_credentials | [`PetstoreAuthCredentials`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/auth/oauth-2-implicit-grant.md) | The credential object for OAuth 2 Implicit Grant |
|
57
57
|
|
58
58
|
The API client can be initialized as follows:
|
59
59
|
|
@@ -98,29 +98,29 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
98
98
|
|
99
99
|
This API uses the following authentication schemes.
|
100
100
|
|
101
|
-
* [`api_key (Custom Header Signature)`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
102
|
-
* [`httpBasic (Basic Authentication)`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
103
|
-
* [`petstore_auth (OAuth 2 Implicit Grant)`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
101
|
+
* [`api_key (Custom Header Signature)`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/auth/custom-header-signature.md)
|
102
|
+
* [`httpBasic (Basic Authentication)`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/auth/basic-authentication.md)
|
103
|
+
* [`petstore_auth (OAuth 2 Implicit Grant)`](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/auth/oauth-2-implicit-grant.md)
|
104
104
|
|
105
105
|
## List of APIs
|
106
106
|
|
107
|
-
* [Pet](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
108
|
-
* [Store](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
109
|
-
* [User](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
107
|
+
* [Pet](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/controllers/pet.md)
|
108
|
+
* [Store](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/controllers/store.md)
|
109
|
+
* [User](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/controllers/user.md)
|
110
110
|
|
111
111
|
## SDK Infrastructure
|
112
112
|
|
113
113
|
### Configuration
|
114
114
|
|
115
|
-
* [ProxySettings](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
115
|
+
* [ProxySettings](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/proxy-settings.md)
|
116
116
|
|
117
117
|
### HTTP
|
118
118
|
|
119
|
-
* [HttpResponse](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
120
|
-
* [HttpRequest](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
119
|
+
* [HttpResponse](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/http-response.md)
|
120
|
+
* [HttpRequest](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/http-request.md)
|
121
121
|
|
122
122
|
### Utilities
|
123
123
|
|
124
|
-
* [ApiHelper](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
125
|
-
* [DateTimeHelper](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.
|
124
|
+
* [ApiHelper](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/api-helper.md)
|
125
|
+
* [DateTimeHelper](https://www.github.com/ZahraN444/rose-nielsen-ruby-sdk/tree/0.1.5/doc/date-time-helper.md)
|
126
126
|
|