Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs/api/namespaces
diff options
context:
space:
mode:
authorLeitwolf112026-10-23 06:01:51 +0300
committerLeitwolf112026-10-23 06:01:51 +0300
commita8d768876e7cff3e3eeaa6e310149ed7f5894db0 (patch)
tree3fd1babfea8ed8f842d9bdb6254de6a018eab088 /docs/api/namespaces
parentcffc8d884ce3620b70c80a9ab98b8f1f03887402 (diff)
downloadprogmaweb-a8d768876e7cff3e3eeaa6e310149ed7f5894db0.tar.gz
Document every OAuth member and namespace for the API reference
The documentation check of CI requires a comment on every API item and a page for every namespace; 38 items of Progmasoft.OAuth had none. The private handlers and helpers get summaries, MemoryOAuthDatabase its field, and docs/api/namespaces describes Progmasoft.OAuth and its Developers, Endpoints, Pages and Storage namespaces. Verified: dotnet build in Release, dotnet docfx with warnings as errors, and CheckDocumentation: all 353 API items are documented.
Diffstat (limited to 'docs/api/namespaces')
-rw-r--r--docs/api/namespaces/Progmasoft.OAuth.Developers.md9
-rw-r--r--docs/api/namespaces/Progmasoft.OAuth.Endpoints.md9
-rw-r--r--docs/api/namespaces/Progmasoft.OAuth.Pages.md9
-rw-r--r--docs/api/namespaces/Progmasoft.OAuth.Storage.md9
-rw-r--r--docs/api/namespaces/Progmasoft.OAuth.md9
5 files changed, 45 insertions, 0 deletions
diff --git a/docs/api/namespaces/Progmasoft.OAuth.Developers.md b/docs/api/namespaces/Progmasoft.OAuth.Developers.md
new file mode 100644
index 0000000..503b35e
--- /dev/null
+++ b/docs/api/namespaces/Progmasoft.OAuth.Developers.md
@@ -0,0 +1,9 @@
+---
+uid: Progmasoft.OAuth.Developers
+summary: *content
+---
+
+<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
+<!-- SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1 -->
+
+The developer portal: the rules an application registration follows, the registry that keeps applications per account, and the portal pages.
diff --git a/docs/api/namespaces/Progmasoft.OAuth.Endpoints.md b/docs/api/namespaces/Progmasoft.OAuth.Endpoints.md
new file mode 100644
index 0000000..0a5ed6d
--- /dev/null
+++ b/docs/api/namespaces/Progmasoft.OAuth.Endpoints.md
@@ -0,0 +1,9 @@
+---
+uid: Progmasoft.OAuth.Endpoints
+summary: *content
+---
+
+<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
+<!-- SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1 -->
+
+The protocol endpoints OpenIddict passes through: authorization with consent, token, user information and end session.
diff --git a/docs/api/namespaces/Progmasoft.OAuth.Pages.md b/docs/api/namespaces/Progmasoft.OAuth.Pages.md
new file mode 100644
index 0000000..b8700aa
--- /dev/null
+++ b/docs/api/namespaces/Progmasoft.OAuth.Pages.md
@@ -0,0 +1,9 @@
+---
+uid: Progmasoft.OAuth.Pages
+summary: *content
+---
+
+<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
+<!-- SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1 -->
+
+The HTML pages of the OAuth host: sign-in, the home page, the applications an account has allowed, and the renderer with its content security policy.
diff --git a/docs/api/namespaces/Progmasoft.OAuth.Storage.md b/docs/api/namespaces/Progmasoft.OAuth.Storage.md
new file mode 100644
index 0000000..3c5194c
--- /dev/null
+++ b/docs/api/namespaces/Progmasoft.OAuth.Storage.md
@@ -0,0 +1,9 @@
+---
+uid: Progmasoft.OAuth.Storage
+summary: *content
+---
+
+<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
+<!-- SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1 -->
+
+The OAuth tables: the Entity Framework context of OpenIddict's stores and application owners, and the numbered schema steps that create them.
diff --git a/docs/api/namespaces/Progmasoft.OAuth.md b/docs/api/namespaces/Progmasoft.OAuth.md
new file mode 100644
index 0000000..748b0ee
--- /dev/null
+++ b/docs/api/namespaces/Progmasoft.OAuth.md
@@ -0,0 +1,9 @@
+---
+uid: Progmasoft.OAuth
+summary: *content
+---
+
+<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> -->
+<!-- SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1 -->
+
+Progmasoft OAuth, the OAuth 2.1 and OpenID Connect provider of Progmasoft accounts on its own host: its settings, scopes, registration, host filter and endpoint mapping.