PublicApi.md in ory-hydra-client-0.0.0.alpha63

- old
+ new

@@ -2,26 +2,26 @@
 
 All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**disconnect_user**](PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel enabled Logout
+[**disconnect_user**](PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
 [**discover_open_id_configuration**](PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
-[**is_instance_ready**](PublicApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
-[**oauth2_token**](PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 token endpoint
-[**oauth_auth**](PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 authorize endpoint
-[**revoke_o_auth2_token**](PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 tokens
+[**is_instance_ready**](PublicApi.md#is_instance_ready) | **GET** /health/ready | Check Readiness Status
+[**oauth2_token**](PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint
+[**oauth_auth**](PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 Authorize Endpoint
+[**revoke_o_auth2_token**](PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 Tokens
 [**userinfo**](PublicApi.md#userinfo) | **GET** /userinfo | OpenID Connect Userinfo
 [**well_known**](PublicApi.md#well_known) | **GET** /.well-known/jwks.json | JSON Web Keys Discovery
 
 
 
 ## disconnect_user
 
 > disconnect_user
 
-OpenID Connect Front-Backchannel enabled Logout
+OpenID Connect Front-Backchannel Enabled Logout
 
 This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-/Back-channel logout:  https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html
 
 ### Example
 
@@ -30,11 +30,11 @@
 require 'ory-hydra-client'
 
 api_instance = OryHydraClient::PublicApi.new
 
 begin
-  #OpenID Connect Front-Backchannel enabled Logout
+  #OpenID Connect Front-Backchannel Enabled Logout
   api_instance.disconnect_user
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->disconnect_user: #{e}"
 end
 ```
@@ -102,11 +102,11 @@
 
 ## is_instance_ready
 
 > HealthStatus is_instance_ready
 
-Check readiness status
+Check Readiness Status
 
 This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
 
 ### Example
 
@@ -115,11 +115,11 @@
 require 'ory-hydra-client'
 
 api_instance = OryHydraClient::PublicApi.new
 
 begin
-  #Check readiness status
+  #Check Readiness Status
   result = api_instance.is_instance_ready
   p result
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->is_instance_ready: #{e}"
 end
@@ -145,13 +145,13 @@
 
 ## oauth2_token
 
 > Oauth2TokenResponse oauth2_token(grant_type, opts)
 
-The OAuth 2.0 token endpoint
+The OAuth 2.0 Token Endpoint
 
-The client makes a request to the token endpoint by sending the following parameters using the \"application/x-www-form-urlencoded\" HTTP request entity-body.  > Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https://oauth.net/code/ > > Do not the the Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
+The client makes a request to the token endpoint by sending the following parameters using the \"application/x-www-form-urlencoded\" HTTP request entity-body.  > Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https://oauth.net/code/ > > Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
 
 ### Example
 
 ```ruby
 # load the gem
@@ -174,11 +174,11 @@
   redirect_uri: 'redirect_uri_example', # String | 
   client_id: 'client_id_example' # String | 
 }
 
 begin
-  #The OAuth 2.0 token endpoint
+  #The OAuth 2.0 Token Endpoint
   result = api_instance.oauth2_token(grant_type, opts)
   p result
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->oauth2_token: #{e}"
 end
@@ -211,11 +211,11 @@
 
 ## oauth_auth
 
 > oauth_auth
 
-The OAuth 2.0 authorize endpoint
+The OAuth 2.0 Authorize Endpoint
 
 This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists.  To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749
 
 ### Example
 
@@ -224,11 +224,11 @@
 require 'ory-hydra-client'
 
 api_instance = OryHydraClient::PublicApi.new
 
 begin
-  #The OAuth 2.0 authorize endpoint
+  #The OAuth 2.0 Authorize Endpoint
   api_instance.oauth_auth
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->oauth_auth: #{e}"
 end
 ```
@@ -253,11 +253,11 @@
 
 ## revoke_o_auth2_token
 
 > revoke_o_auth2_token(token)
 
-Revoke OAuth2 tokens
+Revoke OAuth2 Tokens
 
 Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.
 
 ### Example
 
@@ -276,10 +276,10 @@
 
 api_instance = OryHydraClient::PublicApi.new
 token = 'token_example' # String | 
 
 begin
-  #Revoke OAuth2 tokens
+  #Revoke OAuth2 Tokens
   api_instance.revoke_o_auth2_token(token)
 rescue OryHydraClient::ApiError => e
   puts "Exception when calling PublicApi->revoke_o_auth2_token: #{e}"
 end
 ```