Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity

fix: update mocks and docstrings

Browse source
This commit is contained in:
Mostafa Moradian 2024-06-22 23:33:13 +02:00
parent 0a194c6752
commit e24ff76c1f
No known key found for this signature in database
GPG key ID: F7B99DC0BC342A67
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/core/src/routes/swagger/index.test.ts
View file

@ -120,7 +120,7 @@ describe('GET /swagger.json', () => {
get: {
parameters: [
{
$ref: '#/components/parameters/mockId:root',
$ref: '#/components/parameters/mockId-root',
},
{
name: 'field',
@ -135,7 +135,7 @@ describe('GET /swagger.json', () => {
get: {
parameters: [
{
$ref: '#/components/parameters/mockId:root',
$ref: '#/components/parameters/mockId-root',
},
{
name: 'field',

6
packages/core/src/routes/swagger/utils/parameters.ts
View file

@ -48,7 +48,7 @@ type BuildParameters = {
* For path parameters, this function will try to match reusable ID parameters:
*
* - If the parameter name is `id`, and the path is `/organizations/{id}/users`, the parameter
* `id` will be a reference to `#/components/parameters/organizationId:root`.
* `id` will be a reference to `#/components/parameters/organizationId-root`.
* - If the parameter name ends with `Id`, and the path is `/organizations/{id}/users/{userId}`,
* the parameter `userId` will be a reference to `#/components/parameters/userId`.
*
@ -206,7 +206,7 @@ export const mergeParameters = (destination: unknown[], source: unknown[]) => {
* type: 'string',
* },
* },
* 'organizationId:root': {
* 'organizationId-root': {
* name: 'id',
* // ... same as above
* },
@ -216,7 +216,7 @@ export const mergeParameters = (destination: unknown[], source: unknown[]) => {
* @remarks
* The root path component is the first path component in the path. For example, the root path
* component of `/organizations/{id}/users` is `organizations`. Since the name of the parameter is
* same for all root path components, we need to add an additional key with the `:root` suffix to
* same for all root path components, we need to add an additional key with the `-root` suffix to
* distinguish them.
*
* @param rootComponent The root path component in kebab case (`foo-bar`).