refactor docs for hubic queries
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 59 60
diff --git a/lib/query/hubic/query.ex b/lib/query/hubic/query.ex
index 5c4df5f..567505d 100644
--- a/lib/query/hubic/query.ex
+++ b/lib/query/hubic/query.ex
@@ -17,23 +17,50 @@ defmodule ExOvh.Query.Hubic do
# General Hubic Requests
#########################
- @doc "GET /scope/scope, Get the possible scopes for hubiC API"
+ @doc ~s"""
+ GET /scope/scope, Get the possible scopes for hubiC API
+
+ ### Example:
+ ```elixir
+ import ExOvh.Query.Hubic
+ ExOvh.hubic_request(scope())
+ """
@spec scope() :: ExOvh.Client.raw_query_t
def scope(), do: {:get, "/scope/scope", :nil}
- @doc "GET /account, Get the account object properties"
+ @doc ~s"""
+ GET /account, Get the account object properties
+
+ ### Example:
+ ```elixir
+ import ExOvh.Query.Hubic
+ ExOvh.hubic_request(account())
+ """
@spec account() :: ExOvh.Client.raw_query_t
def account(), do: {:get, "/account", :nil}
- @doc "GET /account/credentials
- Returns openstack credentials for connecting to the file API"
+ @doc ~s"""
+ GET /account/credentials, Returns openstack credentials for connecting to the file API
+
+ ### Example:
+ ```elixir
+ import ExOvh.Query.Hubic
+ ExOvh.hubic_request(openstack_credentials())
+ """
@spec openstack_credentials() :: ExOvh.Client.raw_query_t
def openstack_credentials(), do: {:get, "/account/credentials", :nil}
- @doc "GET /account/usage, Returns used space & quota of your account"
+ @doc ~s"""
+ GET /account/usage, Returns used space & quota of your account
+
+ ### Example:
+ ```elixir
+ import ExOvh.Query.Hubic
+ ExOvh.hubic_request(account_usage())
+ """
@spec account_usage() :: ExOvh.Client.raw_query_t
def account_usage(), do: {:get, "/account/usage", :nil}