Skip to content

Commit

Permalink
autogen(docs): generate and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@aeneasr
aeneasr committed Jan 13, 2021
1 parent 999828a commit 9ff5862
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 89 deletions.
76 changes: 37 additions & 39 deletions .schema/api.swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2004,7 +2004,7 @@
}
},
"formFields": {
"description": "FormFields Fields contains multiple fields",
"description": "Fields contains multiple fields",
"type": "array",
"items": {
"$ref": "#/definitions/formField"
Expand Down Expand Up @@ -2059,6 +2059,7 @@
}
},
"healthNotReadyStatus": {
"description": "HealthNotReadyStatus HealthNotReadyStatus HealthNotReadyStatus health not ready status",
"type": "object",
"properties": {
"errors": {
Expand All @@ -2071,6 +2072,7 @@
}
},
"healthStatus": {
"description": "HealthStatus health status",
"type": "object",
"properties": {
"status": {
Expand All @@ -2082,13 +2084,13 @@
"loginFlow": {
"description": "This object represents a login flow. A login flow is initiated at the \"Initiate Login API / Browser Flow\"\nendpoint by a client.\n\nOnce a login flow is completed successfully, a session cookie or session token will be issued.",
"type": "object",
"title": "Login Flow",
"title": "LoginFlow LoginFlow Login Flow",
"required": [
"expires_at",
"id",
"expires_at",
"issued_at",
"methods",
"request_url"
"request_url",
"methods"
],
"properties": {
"active": {
Expand Down Expand Up @@ -2131,11 +2133,10 @@
}
},
"loginFlowMethod": {
"description": "LoginFlowMethod LoginFlowMethod LoginFlowMethod login flow method",
"type": "object",
"required": [
"method",
"config"
"config",
"method"
],
"properties": {
"config": {
Expand Down Expand Up @@ -2198,13 +2199,13 @@
"recoveryFlow": {
"description": "This request is used when an identity wants to recover their account.\n\nWe recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)",
"type": "object",
"title": "RecoveryFlow RecoveryFlow A Recovery Flow",
"title": "A Recovery Flow",
"required": [
"id",
"expires_at",
"id",
"issued_at",
"request_url",
"methods",
"request_url",
"state"
],
"properties": {
Expand Down Expand Up @@ -2352,11 +2353,10 @@
}
},
"registrationFlowMethod": {
"description": "RegistrationFlowMethod registration flow method",
"type": "object",
"required": [
"method",
"config"
"config",
"method"
],
"properties": {
"config": {
Expand Down Expand Up @@ -2433,27 +2433,24 @@
}
},
"session": {
"description": "Session Session Session Session session",
"type": "object",
"required": [
"id",
"expires_at",
"authenticated_at",
"issued_at",
"identity"
"expires_at",
"id",
"identity",
"issued_at"
],
"properties": {
"active": {
"description": "active",
"type": "boolean"
},
"authenticated_at": {
"description": "authenticated at",
"type": "string",
"format": "date-time"
},
"expires_at": {
"description": "expires at",
"type": "string",
"format": "date-time"
},
Expand All @@ -2464,7 +2461,6 @@
"$ref": "#/definitions/Identity"
},
"issued_at": {
"description": "issued at",
"type": "string",
"format": "date-time"
}
Expand All @@ -2473,14 +2469,14 @@
"settingsFlow": {
"description": "This flow is used when an identity wants to update settings\n(e.g. profile data, passwords, ...) in a selfservice manner.\n\nWe recommend reading the [User Settings Documentation](../self-service/flows/user-settings)",
"type": "object",
"title": "Flow represents a Settings Flow",
"title": "SettingsFlow Flow represents a Settings Flow",
"required": [
"expires_at",
"id",
"identity",
"expires_at",
"issued_at",
"methods",
"request_url",
"methods",
"identity",
"state"
],
"properties": {
Expand Down Expand Up @@ -2527,10 +2523,11 @@
}
},
"settingsFlowMethod": {
"description": "SettingsFlowMethod settings flow method",
"type": "object",
"required": [
"config",
"method"
"method",
"config"
],
"properties": {
"config": {
Expand All @@ -2543,12 +2540,11 @@
}
},
"settingsFlowMethodConfig": {
"description": "SettingsFlowMethodConfig settings flow method config",
"type": "object",
"required": [
"action",
"method",
"fields"
"fields",
"method"
],
"properties": {
"action": {
Expand All @@ -2568,7 +2564,7 @@
}
},
"settingsViaApiResponse": {
"description": "The Response for Settings Flows via API",
"description": "SettingsViaAPIResponse SettingsViaAPIResponse The Response for Settings Flows via API",
"type": "object",
"required": [
"flow",
Expand All @@ -2586,7 +2582,7 @@
"verificationFlow": {
"description": "Used to verify an out-of-band communication\nchannel such as an email address or a phone number.\n\nFor more information head over to: https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation",
"type": "object",
"title": "VerificationFlow VerificationFlow VerificationFlow A Verification Flow",
"title": "A Verification Flow",
"required": [
"methods",
"state"
Expand All @@ -2597,15 +2593,15 @@
"type": "string"
},
"expires_at": {
"description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,\na new request has to be initiated.\nFormat: date-time\nFormat: date-time\nFormat: date-time",
"description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,\na new request has to be initiated.",
"type": "string",
"format": "date-time"
},
"id": {
"$ref": "#/definitions/UUID"
},
"issued_at": {
"description": "IssuedAt is the time (UTC) when the request occurred.\nFormat: date-time\nFormat: date-time\nFormat: date-time",
"description": "IssuedAt is the time (UTC) when the request occurred.",
"type": "string",
"format": "date-time"
},
Expand All @@ -2632,10 +2628,11 @@
}
},
"verificationFlowMethod": {
"description": "VerificationFlowMethod VerificationFlowMethod VerificationFlowMethod VerificationFlowMethod verification flow method",
"type": "object",
"required": [
"config",
"method"
"method",
"config"
],
"properties": {
"config": {
Expand All @@ -2648,11 +2645,12 @@
}
},
"verificationFlowMethodConfig": {
"description": "VerificationFlowMethodConfig verification flow method config",
"type": "object",
"required": [
"action",
"fields",
"method"
"method",
"fields"
],
"properties": {
"action": {
Expand Down
Loading

0 comments on commit 9ff5862

Please sign in to comment.