Skip to content

Commit 6214f94

Browse files
committed
chore: docs updates
1 parent 40ee2eb commit 6214f94

5 files changed

Lines changed: 6 additions & 212 deletions

File tree

user-management/LICENSE

Lines changed: 0 additions & 201 deletions
This file was deleted.

user-management/NOTICE

Lines changed: 0 additions & 4 deletions
This file was deleted.

user-management/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ The User Management Service manages users. It provides one primary API:
66

77
## Architecture
88

9-
### Domain Structure
10-
- **`users/`** - User management domain (`/api/users/v1`)
11-
129
### Separation of Concerns
1310

1411
The project follows a ports and adapters architecture style, split down into `Driving` and `Driven` adapters, as well as a `Core` library.
@@ -35,7 +32,7 @@ You can find the full [Open API specification in the docs folder](./docs/api.yam
3532
## Features
3633

3734
- Register users
38-
- OAuth2.0 with password and client credential grant types
35+
- OIDC authorization code flow (frontend app) and client credentials flow (service->service)
3936
- Get and update user accounts
4037

4138
## Events
@@ -117,6 +114,4 @@ dotnet test
117114

118115
This project enforces high code quality through the use of static analysis tools:
119116

120-
### Built in Static Analyis Tools
121-
122117
.NET has built-in Roslyn analyzers that inspect your C# code for code style and quality issues. To enforce these styles, a [`Directory.build.props`](./Directory.build.props) file is included in the repository root that turns on all static analysis tools.

user-management/src/Stickerlandia.UserManagement.Api/Configurations/AuthorizeOperationFilter.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
namespace Stickerlandia.UserManagement.Api.Configurations;
1111

12+
/// <summary>
13+
/// Operation filter to add authorization responses and security requirements to Swagger operations.
14+
/// </summary>
1215
internal class AuthorizeOperationFilter
1316
: IOperationFilter
1417
{

user-management/src/Stickerlandia.UserManagement.Api/Configurations/DocumentationConfig.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public static IHostApplicationBuilder AddDocumentationEndpoints(this IHostApplic
2626
};
2727
});
2828

29-
// Add API documentation
29+
// Add API documentation
3030
builder.Services.AddSwaggerGen(options =>
3131
{
3232
options.SwaggerDoc("v1", new OpenApiInfo { Title = serviceName, Version = "v1" });
@@ -36,6 +36,7 @@ public static IHostApplicationBuilder AddDocumentationEndpoints(this IHostApplic
3636
var xmlFiles = Directory.GetFiles(AppContext.BaseDirectory, "*.xml");
3737
foreach (var xmlFile in xmlFiles) options.IncludeXmlComments(xmlFile);
3838

39+
// This manually removes some types from the auth-gen Swagger definitions that aren't required.
3940
options.DocumentFilter<RemoveSwaggerDefinitionsFilter>();
4041
options.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
4142
{

0 commit comments

Comments
 (0)