autogen(docs): generate and format documentation

ory · Apr 24, 2020 · 1bbfb37 · 1bbfb37
1 parent bcfc6c4
commit 1bbfb37
Show file tree

Hide file tree

Showing 36 changed files with 15,676 additions and 156 deletions.
diff --git a/.schema/api.swagger.json b/.schema/api.swagger.json
@@ -1821,10 +1821,10 @@
       "description": "It is important that this model object is named JSONWebKey for\n\"swagger generate spec\" to generate only on definition of a\nJSONWebKey.",
       "type": "object",
       "required": [
-        "alg",
-        "kid",
+        "use",
         "kty",
-        "use"
+        "kid",
+        "alg"
       ],
       "properties": {
         "alg": {
@@ -1905,7 +1905,7 @@
       }
     },
     "JSONWebKeySet": {
-      "description": "JSONWebKeySet JSONWebKeySet It is important that this model object is named JSONWebKeySet for\n\"swagger generate spec\" to generate only on definition of a\nJSONWebKeySet. Since one with the same name is previously defined as\nclient.Client.JSONWebKeys and this one is last, this one will be\neffectively written in the swagger spec.",
+      "description": "It is important that this model object is named JSONWebKeySet for\n\"swagger generate spec\" to generate only on definition of a\nJSONWebKeySet. Since one with the same name is previously defined as\nclient.Client.JSONWebKeys and this one is last, this one will be\neffectively written in the swagger spec.",
       "type": "object",
       "properties": {
         "keys": {
@@ -1926,30 +1926,20 @@
       "title": "NullTime implements sql.NullTime functionality."
     },
     "PreviousConsentSession": {
-      "description": "PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession PreviousConsentSession The response used to return used consent requests\nsame as HandledLoginRequest, just with consent_request exposed as json",
+      "description": "The response used to return used consent requests\nsame as HandledLoginRequest, just with consent_request exposed as json",
       "type": "object",
       "properties": {
         "consent_request": {
           "$ref": "#/definitions/consentRequest"
         },
         "grant_access_token_audience": {
-          "description": "GrantedAudience sets the audience the user authorized the client to use. Should be a subset of `requested_access_token_audience`.",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
+          "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "grant_scope": {
-          "description": "GrantScope sets the scope the user authorized the client to use. Should be a subset of `requested_scope`",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
+          "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "handled_at": {
-          "description": "handled at\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time\nFormat: date-time",
-          "type": "string",
-          "format": "date-time"
+          "$ref": "#/definitions/NullTime"
         },
         "remember": {
           "description": "Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same\nclient asks the same user for the same, or a subset of, scope.",
@@ -1977,19 +1967,9 @@
       "title": "The request payload used to accept a consent request.",
       "properties": {
         "grant_access_token_audience": {
-          "description": "grant access token audience",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
           "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "grant_scope": {
-          "description": "grant scope",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
           "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "handled_at": {
@@ -2044,7 +2024,7 @@
     },
     "completedRequest": {
       "type": "object",
-      "title": "CompletedRequest CompletedRequest The response payload sent when accepting or rejecting a login or consent request.",
+      "title": "The response payload sent when accepting or rejecting a login or consent request.",
       "properties": {
         "redirect_to": {
           "description": "RedirectURL is the URL which you should redirect the user to once the authentication process is completed.",
@@ -2086,19 +2066,9 @@
           "type": "string"
         },
         "requested_access_token_audience": {
-          "description": "requested access token audience",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
           "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "requested_scope": {
-          "description": "requested scope",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
           "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "skip": {
@@ -2144,7 +2114,7 @@
     "genericError": {
       "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.",
       "type": "object",
-      "title": "GenericError Error response",
+      "title": "Error response",
       "required": [
         "error"
       ],
@@ -2194,7 +2164,6 @@
       }
     },
     "jsonWebKeySetGeneratorRequest": {
-      "description": "JSONWebKeySetGeneratorRequest JSONWebKeySetGeneratorRequest JSONWebKeySetGeneratorRequest json web key set generator request",
       "type": "object",
       "required": [
         "alg",
@@ -2218,7 +2187,7 @@
     },
     "loginRequest": {
       "type": "object",
-      "title": "LoginRequest LoginRequest Contains information on an ongoing login request.",
+      "title": "Contains information on an ongoing login request.",
       "properties": {
         "challenge": {
           "description": "Challenge is the identifier (\"login challenge\") of the login request. It is used to\nidentify the session.",
@@ -2235,17 +2204,9 @@
           "type": "string"
         },
         "requested_access_token_audience": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
           "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "requested_scope": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
           "$ref": "#/definitions/StringSlicePipeDelimiter"
         },
         "session_id": {
@@ -2415,7 +2376,7 @@
     "oAuth2TokenIntrospection": {
       "description": "https://tools.ietf.org/html/rfc7662",
       "type": "object",
-      "title": "OAuth2TokenIntrospection Introspection contains an access token's session data as specified by IETF RFC 7662, see:",
+      "title": "Introspection contains an access token's session data as specified by IETF RFC 7662, see:",
       "required": [
         "active"
       ],
@@ -2488,35 +2449,29 @@
       "type": "object",
       "properties": {
         "access_token": {
-          "description": "access token",
           "type": "string"
         },
         "expires_in": {
-          "description": "expires in",
           "type": "integer",
           "format": "int64"
         },
         "id_token": {
-          "description": "id token",
           "type": "string"
         },
         "refresh_token": {
-          "description": "refresh token",
           "type": "string"
         },
         "scope": {
-          "description": "scope",
           "type": "string"
         },
         "token_type": {
-          "description": "token type",
           "type": "string"
         }
       }
     },
     "openIDConnectContext": {
       "type": "object",
-      "title": "OpenIDConnectContext OpenIDConnectContext Contains optional information about the OpenID Connect request.",
+      "title": "Contains optional information about the OpenID Connect request.",
       "properties": {
         "acr_values": {
           "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n\u003e Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.",
@@ -2554,30 +2509,25 @@
       "title": "The request payload used to accept a login or consent request.",
       "properties": {
         "error": {
-          "description": "error",
           "type": "string"
         },
         "error_debug": {
-          "description": "error debug",
           "type": "string"
         },
         "error_description": {
-          "description": "error description",
           "type": "string"
         },
         "error_hint": {
-          "description": "error hint",
           "type": "string"
         },
         "status_code": {
-          "description": "status code",
           "type": "integer",
           "format": "int64"
         }
       }
     },
     "userinfoResponse": {
-      "description": "UserinfoResponse UserinfoResponse The userinfo response",
+      "description": "The userinfo response",
       "type": "object",
       "properties": {
         "birthdate": {
@@ -2671,7 +2621,7 @@
     "wellKnown": {
       "description": "It includes links to several endpoints (e.g. /oauth2/token) and exposes information on supported signature algorithms\namong others.",
       "type": "object",
-      "title": "WellKnown WellKnown represents important OpenID Connect discovery metadata",
+      "title": "WellKnown represents important OpenID Connect discovery metadata",
       "required": [
         "issuer",
         "authorization_endpoint",

diff --git a/docs/docs/configure-deploy.mdx b/docs/docs/configure-deploy.mdx
@@ -78,11 +78,11 @@ $ export SECRETS_SYSTEM=$(export LC_CTYPE=C; cat /dev/urandom | tr -dc 'a-zA-Z0-
 $ export DSN=postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable
 
 # Before starting, let's pull the latest ORY Hydra tag from docker.
-$ docker pull oryd/hydra:v1.4.7
+$ docker pull oryd/hydra:1.4.8
 
 # This command will show you all the environment variables that you can set. Read this carefully.
 # It is the equivalent to `hydra help serve`.
-$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.4.7 help serve
+$ docker run -it --rm --entrypoint hydra oryd/hydra:1.4.8 help serve
 
 Starts all HTTP/2 APIs and connects to a database backend.
 [...]
@@ -92,7 +92,7 @@ Starts all HTTP/2 APIs and connects to a database backend.
 # It is the equivalent to `hydra migrate sql --yes postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable`
 $ docker run -it --rm \
   --network hydraguide \
-  oryd/hydra:v1.4.7 \
+  oryd/hydra:1.4.8 \
   migrate sql --yes $DSN
 
 Applying `client` SQL migrations...
@@ -110,7 +110,7 @@ $ docker run -d \
   -e URLS_SELF_ISSUER=https://localhost:9000/ \
   -e URLS_CONSENT=http://localhost:9020/consent \
   -e URLS_LOGIN=http://localhost:9020/login \
-  oryd/hydra:v1.4.7 serve all
+  oryd/hydra:1.4.8 serve all
 
 # And check if it's running:
 $ docker logs ory-hydra-example--hydra
@@ -178,7 +178,7 @@ ORY Hydra can be managed using the Hydra Command Line Interface (CLI), which is
 using ORY Hydra's REST APIs. To see the available commands, run:
 
 ```shell
-$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.4.7 help
+$ docker run --rm -it --entrypoint hydra oryd/hydra:1.4.8 help
 Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider
 
 Usage:
@@ -237,7 +237,7 @@ URLs the client may request:
 $ docker run --rm -it \
   -e HYDRA_ADMIN_URL=https://ory-hydra-example--hydra:4445 \
   --network hydraguide \
-  oryd/hydra:v1.4.7 \
+  oryd/hydra:1.4.8 \
   clients create --skip-tls-verify \
     --id facebook-photo-backup \
     --secret some-secret \
@@ -284,7 +284,7 @@ for an access token. The same thing happens with this command:
 $ docker run --rm -it \
   --network hydraguide \
   -p 9010:9010 \
-  oryd/hydra:v1.4.7 \
+  oryd/hydra:1.4.8 \
   token user --skip-tls-verify \
     --port 9010 \
     --auth-url https://localhost:9000/oauth2/auth \

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,8 +11,8 @@ binaries, Docker Images and support various package managers.
 We recommend using Docker to run ORY Hydra:
 
 ```shell
-$ docker pull oryd/hydra:v1.4.7
-$ docker run --rm -it oryd/hydra:v1.4.7 help
+$ docker pull oryd/hydra:1.4.8
+$ docker run --rm -it oryd/hydra:1.4.8 help
 ```
 
 ## macOS
@@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/hydra/master/install.sh) -b . v1.4.7
+$ bash <(curl https://raw.githubusercontent.com/ory/hydra/master/install.sh) -b . 1.4.8
 $ ./hydra help
 ```