fix docs for conversion to hex docs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
diff --git a/docs/getting_started.md b/docs/getting_started.md
index cae9858..c0bce49 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -51,6 +51,7 @@ export MY_APP_OVH_CLIENT_CONSUMER_KEY="<application_consumer_key>"
***NOTE:*** Matching naming between `MyApp.OvhClient` and `MY_APP_OVH_CLIENT_APPLICATION_KEY` variables is expected.
- Basic settings
+
```elixir
config :my_app, MyApp.OvhClient,
ovh: [
@@ -61,6 +62,7 @@ export MY_APP_OVH_CLIENT_CONSUMER_KEY="<application_consumer_key>"
```
- More elaborate settings
+
```elixir
config :my_app, MyApp.OvhClient,
ovh: [
@@ -127,18 +129,21 @@ end
- `GET /me`
+
```
%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/me"} \
|> MyApp.OvhClient.request!()
```
- `GET /me/api/application`
+
```
%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/me/api/application"} \
|> MyApp.OvhClient.request!()
```
- `GET /me/api/application/#{app_id}`
+
```
app_id = "0"
%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/me/api/application/#{app_id}"} \
@@ -146,6 +151,7 @@ app_id = "0"
```
- `GET /cloud/project/{serviceName}/storage`
+
```
service_name = "service_name" \
%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/cloud/project/#{service_name}/storage"} \
@@ -161,6 +167,7 @@ using *Method 1* as above. Pull requests for helper functions for other parts of
*Eventually, I would like to write a macro to create the queries.*
- `GET /cloud/project/{serviceName}/storage`
+
```
ExOvh.Services.V1.Cloud.Cloudstorage.Query.get_containers(service_name) \
|> ExOvh.request!()