Skip to content

Commit e62329d

Browse files
chore: update dependencies and improve documentation links
- Added new dependencies: `github.com/google/uuid` and `github.com/lestrrat-go/jwx/v2`. - Updated existing dependencies to their latest versions, including `goa.design/goa/v3` and various `golang.org/x` packages. - Revised documentation links in the README and related files to reflect the new directory structure for subjects. - Adjusted paths in documentation files to ensure correct navigation to internal resources. Jira Ticket: https://linuxfoundation.atlassian.net/browse/LFXV2-888 Signed-off-by: Mauricio Zanetti Salomao <mauriciozanetti86@gmail.com>
1 parent 2eff72b commit e62329d

File tree

20 files changed

+73
-75
lines changed

20 files changed

+73
-75
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Look up users by their email addresses to retrieve usernames or subject identifi
6666
- `lfx.auth-service.email_to_username` - Look up username by email
6767
- `lfx.auth-service.email_to_sub` - Look up subject identifier by email
6868

69-
**[View Email Lookup Documentation](docs/email_lookups.md)**
69+
**[View Email Lookup Documentation](docs/subjects/email_lookups.md)**
7070

7171
---
7272

@@ -77,7 +77,7 @@ Retrieve and update user profile metadata using various input types (JWT tokens,
7777
- `lfx.auth-service.user_metadata.read` - Retrieve user metadata
7878
- `lfx.auth-service.user_metadata.update` - Update user profile
7979

80-
**[View User Metadata Documentation](docs/user_metadata.md)**
80+
**[View User Metadata Documentation](docs/subjects/user_metadata.md)**
8181

8282
---
8383

@@ -87,7 +87,7 @@ Retrieve user email addresses (primary and alternate emails) using various input
8787
**Subjects:**
8888
- `lfx.auth-service.user_emails.read` - Retrieve user email addresses
8989

90-
**[View User Emails Documentation](docs/user_emails.md)** - **Note:** Currently only supported for Authelia
90+
**[View User Emails Documentation](docs/subjects/user_emails.md)** - **Note:** Currently only supported for Authelia
9191

9292
---
9393

@@ -98,7 +98,7 @@ Two-step verification flow for verifying ownership of alternate email addresses.
9898
- `lfx.auth-service.email_linking.send_verification` - Send OTP to email
9999
- `lfx.auth-service.email_linking.verify` - Verify email with OTP
100100

101-
**[View Email Verification Documentation](docs/email_verification.md)** - Includes complete flow diagram
101+
**[View Email Verification Documentation](docs/subjects/email_verification.md)** - Includes complete flow diagram
102102

103103
---
104104

@@ -108,7 +108,7 @@ Link verified identities (such as verified email addresses) to user accounts.
108108
**Subjects:**
109109
- `lfx.auth-service.user_identity.link` - Link verified identity to user
110110

111-
**[View Identity Linking Documentation](docs/identity_linking.md)**
111+
**[View Identity Linking Documentation](docs/subjects/identity_linking.md)**
112112

113113
---
114114

docs/subjects/email_lookups.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,5 @@ nats request lfx.auth-service.email_to_sub zephyr.stormwind@mythicaltech.io
9898
- Linked/alternate email addresses are **not** supported for lookup
9999
- The service works with Auth0, Authelia, and mock repositories based on configuration
100100
- The returned subject identifier is the canonical user identifier used throughout the system
101-
- For Authelia-specific SUB identifier details and how they are populated, see: [`../internal/infrastructure/authelia/README.md`](../internal/infrastructure/authelia/README.md)
101+
- For Authelia-specific SUB identifier details and how they are populated, see: [`../../internal/infrastructure/authelia/README.md`](../../internal/infrastructure/authelia/README.md)
102102

docs/subjects/email_verification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,6 @@ nats request lfx.auth-service.email_linking.verify '{
193193
- OTP codes are time-sensitive and available for a valid time period
194194
- The service prevents linking an email that is already verified and linked to another user
195195
- The returned token (ID token) can be used to link the verified email to the user account using the identity linking operation (see [Identity Linking Documentation](identity_linking.md))
196-
- For detailed Auth0-specific implementation details and technical information about the passwordless flow, see: [`../internal/infrastructure/auth0/README.md`](../internal/infrastructure/auth0/README.md)
196+
- For detailed Auth0-specific implementation details and technical information about the passwordless flow, see: [`../../internal/infrastructure/auth0/README.md`](../../internal/infrastructure/auth0/README.md)
197197

198198

docs/subjects/user_emails.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ nats request lfx.auth-service.user_emails.read "john.doe" | jq '.data.alternate_
142142
- Primary email is always present if the user exists
143143
- Alternate emails array may be empty if the user has not linked any additional email addresses
144144
- Only verified alternate emails should be considered as confirmed user identities
145-
- For detailed Auth0-specific behavior and limitations, see: [`../internal/infrastructure/auth0/README.md`](../internal/infrastructure/auth0/README.md)
146-
- For detailed Authelia-specific behavior and SUB management, see: [`../internal/infrastructure/authelia/README.md`](../internal/infrastructure/authelia/README.md)
145+
- For detailed Auth0-specific behavior and limitations, see: [`../../internal/infrastructure/auth0/README.md`](../../internal/infrastructure/auth0/README.md)
146+
- For detailed Authelia-specific behavior and SUB management, see: [`../../internal/infrastructure/authelia/README.md`](../../internal/infrastructure/authelia/README.md)
147147

148148
---
149149

docs/subjects/user_metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ nats request lfx.auth-service.user_metadata.read "john.doe"
108108
- The service automatically detects input type and applies the appropriate lookup strategy
109109
- JWT tokens are validated for signature and expiration before extracting subject information
110110
- The target identity provider is determined by the `USER_REPOSITORY_TYPE` environment variable
111-
- For detailed Auth0-specific behavior and limitations, see: [`../internal/infrastructure/auth0/README.md`](../internal/infrastructure/auth0/README.md)
112-
- For detailed Authelia-specific behavior and SUB management, see: [`../internal/infrastructure/authelia/README.md`](../internal/infrastructure/authelia/README.md)
111+
- For detailed Auth0-specific behavior and limitations, see: [`../../internal/infrastructure/auth0/README.md`](../../internal/infrastructure/auth0/README.md)
112+
- For detailed Authelia-specific behavior and SUB management, see: [`../../internal/infrastructure/authelia/README.md`](../../internal/infrastructure/authelia/README.md)
113113

114114
---
115115

gen/auth_service/client.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/auth_service/endpoints.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/auth_service/service.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/auth_service/client/cli.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/auth_service/client/client.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)