-
-
Notifications
You must be signed in to change notification settings - Fork 343
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: move documentation to ory/docs and move to OAS3.0 generator (…
…#833) Co-authored-by: zepatrik <zepatrik@users.noreply.github.com>
- Loading branch information
Showing
421 changed files
with
26,304 additions
and
61,883 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
disallowAdditionalPropertiesIfNotPresent: true | ||
packageName: client | ||
generateInterfaces: true | ||
isGoSubmodule: false | ||
structPrefix: true | ||
enumClassPrefix: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
npmName: "@ory/kratos-client" | ||
npmVersion: 0.0.0 | ||
# typescriptThreePlus: true | ||
#npmRepository: https://github.com/ory/sdk.git | ||
supportsES6: true | ||
ensureUniqueParams: true | ||
modelPropertyNaming: original |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
- op: replace | ||
path: /paths/~1health~1alive | ||
value: | ||
get: | ||
description: |- | ||
This endpoint returns a HTTP 200 status code when {{.ProjectHumanName}} is accepting incoming | ||
HTTP requests. This status does currently not include checks whether the database connection is working. | ||
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. | ||
operationId: isAlive | ||
responses: | ||
'200': | ||
content: | ||
application/json: | ||
schema: | ||
"$ref": "#/components/schemas/healthStatus" | ||
description: {{.ProjectHumanName}} is ready to accept connections. | ||
'500': | ||
content: | ||
application/json: | ||
schema: | ||
"$ref": "#/components/schemas/genericError" | ||
description: genericError | ||
summary: Check HTTP Server Status | ||
tags: {{ .HealthPathTags | toJson }} | ||
- op: replace | ||
path: /paths/~1health~1ready | ||
value: | ||
get: | ||
operationId: isReady | ||
description: |- | ||
This endpoint returns a HTTP 200 status code when {{.ProjectHumanName}} 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 {{.ProjectHumanName}}, the health status will never | ||
refer to the cluster state, only to a single instance. | ||
responses: | ||
'200': | ||
content: | ||
application/json: | ||
schema: | ||
type: object | ||
properties: | ||
status: | ||
description: Always "ok". | ||
type: string | ||
description: {{.ProjectHumanName}} is ready to accept requests. | ||
'503': | ||
content: | ||
application/json: | ||
schema: | ||
properties: | ||
errors: | ||
additionalProperties: | ||
type: string | ||
description: Errors contains a list of errors that caused the not ready status. | ||
type: object | ||
type: object | ||
description: Ory Kratos is not yet ready to accept requests. | ||
summary: Check HTTP Server and Database Status | ||
tags: {{ .HealthPathTags | toJson }} | ||
- op: replace | ||
path: /paths/~1version | ||
value: | ||
get: | ||
description: |- | ||
This endpoint returns the version of {{.ProjectHumanName}}. | ||
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 version will never | ||
refer to the cluster state, only to a single instance. | ||
operationId: getVersion | ||
responses: | ||
'200': | ||
content: | ||
application/json: | ||
schema: | ||
type: object | ||
properties: | ||
version: | ||
description: The version of {{.ProjectHumanName}}. | ||
type: string | ||
description: Returns the {{.ProjectHumanName}} version. | ||
summary: Return Running Software Version. | ||
tags: {{ .HealthPathTags | toJson }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
- op: replace | ||
path: /info | ||
value: | ||
title: Ory Oathkeeper API | ||
description: | | ||
Documentation for all of Ory Oathkeeper's APIs. | ||
version: >- | ||
{{ getenv "CIRCLE_TAG" }} | ||
license: | ||
name: Apache 2.0 | ||
contact: | ||
email: "hi@ory.sh" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
language: go | ||
|
||
install: | ||
- go get -d -v . | ||
|
||
script: | ||
- go build -v ./ | ||
|
Oops, something went wrong.