From 5445167b707f00b65d1d3e272c1896eed0c4fbbd Mon Sep 17 00:00:00 2001 From: Oleksii Nikiforov Date: Mon, 3 Jun 2024 18:26:11 +0300 Subject: [PATCH] docs: Add Reference documentation (#114) * docs: Add Reference documentation * docs: Add submodule --- .gitmodules | 3 +++ README.md | 6 +++++- docs/.vitepress/config.mts | 3 ++- docs/admin-rest-api/admin-api-kiota.md | 11 ++++++++--- docs/admin-rest-api/group-client.md | 8 +++++++- docs/admin-rest-api/realm-client.md | 8 +++++++- docs/admin-rest-api/user-client.md | 8 +++++++- docs/authorization/resources-client-reference.md | 8 +++++++- docs/protection-api/protected-resource-client.md | 8 +++++++- 9 files changed, 53 insertions(+), 10 deletions(-) create mode 100644 .gitmodules diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..dd7f1f5c --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "docs-reference"] + path = docs-reference + url = https://github.com/NikiforovAll/keycloak-authorization-services-dotnet-docs diff --git a/README.md b/README.md index 5b19e9b2..0b7c58f0 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,11 @@ Easy Authentication and Authorization with Keycloak in .NET. ## Documentation -See the docs: +For Developer Documentation see: + +### API Reference + +See: ## Getting Started diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 21a613a9..83ae0962 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -17,8 +17,9 @@ export default withMermaid({ nav: [ { text: 'Home', link: '/' }, { text: 'Getting Started', link: '/introduction' }, - { text: 'Migration', link: '/migration' }, { text: 'Examples', link: 'examples/auth-getting-started' }, + { text: 'Migration', link: '/migration' }, + { text: 'API Reference', link: 'https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/' }, { text: 'Blog', link: 'blogs' }, { text: 'Join Chat', link: 'https://discord.gg/S449PhBPRQ' }, ], diff --git a/docs/admin-rest-api/admin-api-kiota.md b/docs/admin-rest-api/admin-api-kiota.md index aa426206..143f416b 100644 --- a/docs/admin-rest-api/admin-api-kiota.md +++ b/docs/admin-rest-api/admin-api-kiota.md @@ -2,13 +2,18 @@ This `KeycloakAdminApiClient` was generated using the *Kiota* library. -```bash -dotnet add package Keycloak.AuthServices.Sdk.Kiota -``` +> [!TIP] +> API Reference: [Keycloak.AuthServices.Sdk.Kiota](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Kiota.ServiceCollectionExtensions.html) > [!NOTE] > Kiota is a powerful command line tool developed by Microsoft that simplifies the process of generating API clients for calling any OpenAPI-described API. See [OpenAPI Support](/admin-rest-api/admin-api-openapi) for more details. +## Getting Started + +```bash +dotnet add package Keycloak.AuthServices.Sdk.Kiota +``` + ```csharp /// /// Adds for Keycloak Admin API. diff --git a/docs/admin-rest-api/group-client.md b/docs/admin-rest-api/group-client.md index 4d8ecfdc..52eccc05 100644 --- a/docs/admin-rest-api/group-client.md +++ b/docs/admin-rest-api/group-client.md @@ -1,3 +1,9 @@ -# IKeycloakGroupClient +# API Reference - IKeycloakGroupClient + +API Reference docs: [Keycloak.AuthServices.Sdk.Admin.IKeycloakGroupClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Admin.IKeycloakGroupClient.html) + +::: details IKeycloakGroupClient.cs <<< @/../src/Keycloak.AuthServices.Sdk/Admin/IKeycloakGroupClient.cs + +::: diff --git a/docs/admin-rest-api/realm-client.md b/docs/admin-rest-api/realm-client.md index f0d67c17..1f675dd0 100644 --- a/docs/admin-rest-api/realm-client.md +++ b/docs/admin-rest-api/realm-client.md @@ -1,3 +1,9 @@ -# IKeycloakRealmClient +# API Reference - IKeycloakRealmClient + +API Reference docs: [Keycloak.AuthServices.Sdk.Admin.IKeycloakRealmClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Admin.IKeycloakRealmClient.html) + +::: details IKeycloakRealmClient.cs <<< @/../src/Keycloak.AuthServices.Sdk/Admin/IKeycloakRealmClient.cs + +::: diff --git a/docs/admin-rest-api/user-client.md b/docs/admin-rest-api/user-client.md index 0ef717ef..753bd1cb 100644 --- a/docs/admin-rest-api/user-client.md +++ b/docs/admin-rest-api/user-client.md @@ -1,3 +1,9 @@ -# IKeycloakUserClient +# API Reference - IKeycloakUserClient + +API Reference docs: [Keycloak.AuthServices.Sdk.Admin.IKeycloakUserClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Admin.IKeycloakUserClient.html) + +::: details IKeycloakUserClient.cs <<< @/../src/Keycloak.AuthServices.Sdk/Admin/IKeycloakUserClient.cs + +::: diff --git a/docs/authorization/resources-client-reference.md b/docs/authorization/resources-client-reference.md index cdde4cb8..44579313 100644 --- a/docs/authorization/resources-client-reference.md +++ b/docs/authorization/resources-client-reference.md @@ -1,3 +1,9 @@ -# IAuthorizationServerClient +# API Reference - IAuthorizationServerClient + +API Reference docs: [Keycloak.AuthServices.Authorization.AuthorizationServer.IAuthorizationServerClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Authorization.AuthorizationServer.IAuthorizationServerClient.html) + +::: details IAuthorizationServerClient.cs <<< @/../src/Keycloak.AuthServices.Authorization/AuthorizationServer/IAuthorizationServerClient.cs + +::: diff --git a/docs/protection-api/protected-resource-client.md b/docs/protection-api/protected-resource-client.md index a4bd0c15..17f25f09 100644 --- a/docs/protection-api/protected-resource-client.md +++ b/docs/protection-api/protected-resource-client.md @@ -1,3 +1,9 @@ -# IKeycloakProtectedResourceClient +# API Reference - IKeycloakProtectedResourceClient + +API Reference docs: [Keycloak.AuthServices.Sdk.Protection.IKeycloakProtectedResourceClient](https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs/api-reference/Keycloak.AuthServices.Sdk.Protection.IKeycloakProtectedResourceClient.html) + +::: details IKeycloakProtectedResourceClient.cs <<< @/../src/Keycloak.AuthServices.Sdk/Protection/IKeycloakProtectedResourceClient.cs + +:::