Skip to content

Commit 7bf900e

Browse files
authored
Fix typo documentation (#584)
loggued => logged
1 parent 18c232a commit 7bf900e

File tree

8 files changed

+16
-16
lines changed

8 files changed

+16
-16
lines changed

doc/7/controllers/auth/create-api-key/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
code: true
33
type: page
44
title: createApiKey
5-
description: Creates a new API key for the currently loggued user.
5+
description: Creates a new API key for the currently logged user.
66
---
77

88
# createApiKey
@@ -11,7 +11,7 @@ description: Creates a new API key for the currently loggued user.
1111

1212
<SinceBadge version="Kuzzle 2.1.0" />
1313

14-
Creates a new API key for the currently loggued user.
14+
Creates a new API key for the currently logged user.
1515

1616
<br />
1717

doc/7/controllers/auth/create-api-key/snippets/create-api-key.test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: auth#createApiKey
2-
description: Creates a new API key for the currently loggued user.
2+
description: Creates a new API key for the currently logged user.
33
hooks:
44
before: >
55
curl --fail -H "Content-type: application/json" -d '{

doc/7/controllers/auth/delete-api-key/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
code: true
33
type: page
44
title: deleteApiKey
5-
description: Deletes an API key for the currently loggued user.
5+
description: Deletes an API key for the currently logged user.
66
---
77

88
# deleteApiKey
@@ -11,7 +11,7 @@ description: Deletes an API key for the currently loggued user.
1111

1212
<SinceBadge version="Kuzzle 2.1.0" />
1313

14-
Deletes an API key for the currently loggued user.
14+
Deletes an API key for the currently logged user.
1515

1616
<br />
1717

doc/7/controllers/auth/delete-api-key/snippets/delete-api-key.test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: auth#deleteApiKey
2-
description: Deletes an API key for the currently loggued user
2+
description: Deletes an API key for the currently logged user
33
hooks:
44
before: >
55
curl --fail -H "Content-type: application/json" -d '{

doc/7/controllers/auth/search-api-keys/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
code: true
33
type: page
44
title: searchApiKeys
5-
description: Searches API keys for the currently loggued user.
5+
description: Searches API keys for the currently logged user.
66
---
77

88
# searchApiKeys
@@ -11,7 +11,7 @@ description: Searches API keys for the currently loggued user.
1111

1212
<SinceBadge version="Kuzzle 2.1.0" />
1313

14-
Searches API keys for the currently loggued user.
14+
Searches API keys for the currently logged user.
1515

1616
<br />
1717

@@ -39,7 +39,7 @@ Koncorde filters will be translated into an Elasticsearch query.
3939
Koncorde `bool` operator and `regexp` clause are not supported for search queries.
4040
:::
4141

42-
If left empty, the result will return all available API keys of the currently loggued user.
42+
If left empty, the result will return all available API keys of the currently logged user.
4343

4444
### options
4545

doc/7/controllers/auth/search-api-keys/snippets/search-api-keys-es.test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: auth#searchApiKeys-es
2-
description: Searches API keys for the currently loggued user.
2+
description: Searches API keys for the currently logged user.
33
hooks:
44
before: >
55
curl --fail -H "Content-type: application/json" -d '{

doc/7/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde.test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: auth#searchApiKeys-koncorde
2-
description: Searches API keys for the currently loggued user.
2+
description: Searches API keys for the currently logged user.
33
hooks:
44
before: >
55
curl --fail -H "Content-type: application/json" -d '{

src/controllers/Auth.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export class AuthController extends BaseController {
6161
}
6262

6363
/**
64-
* Creates a new API key for the currently loggued user.
64+
* Creates a new API key for the currently logged user.
6565
*
6666
* @see https://docs.kuzzle.io/sdk/js/7/controllers/auth/create-api-key
6767
*
@@ -92,7 +92,7 @@ export class AuthController extends BaseController {
9292
}
9393

9494
/**
95-
* Deletes an API key for the currently loggued user.
95+
* Deletes an API key for the currently logged user.
9696
*
9797
* @see https://docs.kuzzle.io/sdk/js/7/controllers/auth/delete-api-key
9898
*
@@ -112,7 +112,7 @@ export class AuthController extends BaseController {
112112
}
113113

114114
/**
115-
* Searches API keys for the currently loggued user.
115+
* Searches API keys for the currently logged user.
116116
*
117117
* @see https://docs.kuzzle.io/sdk/js/7/controllers/auth/search-api-keys
118118
*
@@ -258,7 +258,7 @@ export class AuthController extends BaseController {
258258
* @param options Additional options
259259
* - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
260260
*
261-
* @returns Currently loggued User
261+
* @returns Currently logged User
262262
*/
263263
getCurrentUser (options: { queuable?: boolean } = {}): Promise<User> {
264264
return this.query({
@@ -438,7 +438,7 @@ export class AuthController extends BaseController {
438438
* @param options Additional options
439439
* - `queuable` If true, queues the request during downtime, until connected to Kuzzle again
440440
*
441-
* @returns Currently loggued User
441+
* @returns Currently logged User
442442
*/
443443
updateSelf (
444444
content: JSONObject,

0 commit comments

Comments
 (0)