Skip to content

Commit

Permalink
fix: spec
Browse files Browse the repository at this point in the history
  • Loading branch information
sattvikc committed Jul 17, 2024
1 parent 905fb94 commit e10ec2c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [5.1.0]

- Adds `/appid-<appid>/<tenantid>/recipe/multitenancy/tenant/core-config` GET API.
- Adds `/appid-<appid>/<tenantid>/recipe/dashboard/tenant/core-config` GET API.
- Adds optional `websiteDomain` and `apiDomain` query param to GET `/appid-<appId>/apiversion` API.
- Deprecates the recipe enabled booleans for ConnectionURIDomains, Apps and Tenants and now the `firstFactors` and `requiredSecondaryFactors` are used to control the login methods.
- Deprecated APIs:
- PUT `/recipe/multitenancy/connectionuridomain`
Expand Down
32 changes: 22 additions & 10 deletions api_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4340,6 +4340,18 @@ paths:
Get a list of compatible CDI versions
parameters:
- $ref: '#/components/parameters/api-key'
- in: query
name: websiteDomain
schema:
type: string
example: https://example.com
required: false
- in: query
name: apiDomain
schema:
type: string
example: https://api.example.com
required: false
responses:
'200':
description: get api version
Expand Down Expand Up @@ -5164,14 +5176,14 @@ paths:
This request must originate from public app and public tenant on the base
connection uri domain.
If creating a new connection uri domain, only the login methods set to true will be enabled and rest will be disabled by default.
This `firstFactors` can be set to following values:
- `null`: When set to `null`, the SDK will use firstFactors defined in the SDK
- `[]` (empty array): No first factors would be enabled for the tenant
- non-empty array: The first factors that are enabled for the tenant
If first factors are not specified while creating a new connection uri domain, all the login methods will be enabled by default.
`requiredSecondaryFactors` can be set to null to remove all entries in the core, or a non empty string array to be updated in the core. Setting of empty array is disallowed.
If updating an existing connection uri domain,
Expand Down Expand Up @@ -5509,14 +5521,14 @@ paths:
SuperTokens subscription license key is required.
If creating a new app, only the login methods set to true will be enabled and rest will be disabled by default.
This `firstFactors` can be set to following values:
- `null`: When set to `null`, the SDK will use firstFactors defined in the SDK
- `[]` (empty array): No first factors would be enabled for the tenant
- non-empty array: The first factors that are enabled for the tenant
If `firstFactors` is not specified while creating an app, all the login methods will be enabled by default.
`requiredSecondaryFactors` can be set to null to remove all entries in the core, or a non empty string array to be updated in the core. Setting of empty array is disallowed.
If updating an existing app,
Expand Down Expand Up @@ -5831,14 +5843,14 @@ paths:
SuperTokens subscription license key is required.
If creating a new tenant, only the login methods set to true will be enabled and rest will be disabled by default.
This `firstFactors` can be set to following values:
- `null`: When set to `null`, the SDK will use firstFactors defined in the SDK
- `[]` (empty array): No first factors would be enabled for the tenant
- non-empty array: The first factors that are enabled for the tenant
If `firstFactors` is not specified while creating a new tenant, none of the login methods will be enabled by default.
`requiredSecondaryFactors` can be set to null to remove all entries in the core, or a non empty string array to be updated in the core. Setting of empty array is disallowed.
If updating an existing tenant,
Expand Down Expand Up @@ -6004,14 +6016,14 @@ paths:
'500':
$ref: '#/components/responses/500'

/appid-<appId>/<tenantId>/recipe/multitenancy/tenant/core-config:
/appid-<appId>/<tenantId>/recipe/dashboard/tenant/core-config:
get:
tags:
- Multitenancy Recipe
- Dashboard Recipe
description: |
Get the core config of the tenant specified by the url prefix, along with the metadata of each of the fields.
operationId: tenantCoreConfigGET
operationId: tenantCoreConfigForDashboardGET
parameters:
- $ref: '#/components/parameters/multitenancyRid'
- $ref: '#/components/parameters/api-key'
Expand Down Expand Up @@ -6539,7 +6551,7 @@ components:
schema:
type: string
api-key:
name: api-key
name: Authorization
in: header
example: ajs30Nlbs0DjvsdFIne934n8NVee5n
required: false
Expand Down

0 comments on commit e10ec2c

Please sign in to comment.