Skip to content

Commit

Permalink
refactor: remove common keyword from API spec
Browse files Browse the repository at this point in the history
BREAKING CHANGE: The "common" keyword has been removed from the Swagger 2.0 spec which deprecates the `common` module / package / class (depending on the generated SDK). Please use `public` or `admin` instead!

Additionally, the SDK for TypeScript now uses the `fetch` API which allows the SDK to be used in both client-side as well as server-side contexts. Please note that several methods and parameters in the generated TypeScript SDK have changed. Please check the TypeScript results to see what needs to be changed!
  • Loading branch information
aeneasr committed Sep 28, 2020
1 parent 5f56ab5 commit 6619562
Show file tree
Hide file tree
Showing 44 changed files with 1,576 additions and 1,692 deletions.
12 changes: 2 additions & 10 deletions .schema/api.swagger.json
Expand Up @@ -402,9 +402,7 @@
"https"
],
"tags": [
"common",
"public",
"admin"
"public"
],
"operationId": "getSchema",
"parameters": [
Expand Down Expand Up @@ -494,7 +492,7 @@
},
"/self-service/errors": {
"get": {
"description": "This endpoint returns the error associated with a user-facing self service errors.\n\nWhen accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent\ntoken scanning attacks, the public endpoint does not return 404 status codes.\n\nThis endpoint supports stub values to help you implement the error UI:\n\n`?error=stub:500` - returns a stub 500 (Internal Server Error) error.\n\nMore information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).",
"description": "This endpoint returns the error associated with a user-facing self service errors.\n\nThis endpoint supports stub values to help you implement the error UI:\n\n`?error=stub:500` - returns a stub 500 (Internal Server Error) error.\n\nMore information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).",
"produces": [
"application/json"
],
Expand All @@ -503,7 +501,6 @@
"https"
],
"tags": [
"common",
"public",
"admin"
],
Expand Down Expand Up @@ -624,7 +621,6 @@
"https"
],
"tags": [
"common",
"public",
"admin"
],
Expand Down Expand Up @@ -814,7 +810,6 @@
"https"
],
"tags": [
"common",
"public",
"admin"
],
Expand Down Expand Up @@ -986,7 +981,6 @@
"https"
],
"tags": [
"common",
"public",
"admin"
],
Expand Down Expand Up @@ -1165,7 +1159,6 @@
"https"
],
"tags": [
"common",
"public",
"admin"
],
Expand Down Expand Up @@ -1411,7 +1404,6 @@
"https"
],
"tags": [
"common",
"public",
"admin"
],
Expand Down

0 comments on commit 6619562

Please sign in to comment.