refactor: rename Well-known tag

impierce · Sep 21, 2024 · 5d20f17 · 5d20f17
1 parent ca2ceaf
commit 5d20f17
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 8 deletions.
diff --git a/agent_api_rest/openapi.yaml b/agent_api_rest/openapi.yaml
@@ -12,7 +12,7 @@ paths:
   /.well-known/oauth-authorization-server:
     get:
       tags:
-      - Well-known
+      - (.well-known)
       - (public)
       summary: Authorization Server Metadata
       description: Standard OpenID Connect discovery endpoint for authorization metadata.
@@ -29,7 +29,7 @@ paths:
   /.well-known/openid-credential-issuer:
     get:
       tags:
-      - Well-known
+      - (.well-known)
       - (public)
       summary: Credential Issuer Metadata
       description: Standard OpenID Connect discovery endpoint for issuer metadata.
@@ -218,7 +218,7 @@ paths:
       tags:
       - Holder
       summary: Get all credentials
-      description: Retrieve all credentials that UniCore currently holds.
+      description: Retrieve all credentials that this UniCore instance currently holds.
       operationId: credentials
       responses:
         '200':
@@ -300,5 +300,10 @@ components:
 tags:
 - name: (public)
   description: A collection of endpoints that should be publicly accessible without authentication. They are used to resolve metadata or allow communication with wallets.
-- name: Well-known
+- name: (.well-known)
   description: Well-known endpoints provide metadata about the server.
+- name: Issuance
+  description: Issue credentials to holders that will store them in their wallets.
+  externalDocs:
+    url: https://docs.impierce.com
+    description: Official Documentation
diff --git a/agent_api_rest/src/holder/holder/credentials/mod.rs b/agent_api_rest/src/holder/holder/credentials/mod.rs
@@ -10,7 +10,7 @@ use serde_json::json;
 
 /// Get all credentials
 ///
-/// Retrieve all credentials that UniCore currently holds.
+/// Retrieve all credentials that this UniCore instance currently holds.
 #[utoipa::path(
     get,
     path = "/holder/credentials",

diff --git a/agent_api_rest/src/issuance/credential_issuer/well_known/oauth_authorization_server.rs b/agent_api_rest/src/issuance/credential_issuer/well_known/oauth_authorization_server.rs
@@ -15,7 +15,7 @@ use axum::{
 #[utoipa::path(
     get,
     path = "/.well-known/oauth-authorization-server",
-    tag = "Well-known",
+    tag = "(.well-known)",
     tags = ["(public)"],
     responses(
         (status = 200, description = "Successfully returns the Authorization Server Metadata", body = [AuthorizationServerMetadata])

diff --git a/agent_api_rest/src/issuance/credential_issuer/well_known/openid_credential_issuer.rs b/agent_api_rest/src/issuance/credential_issuer/well_known/openid_credential_issuer.rs
@@ -15,7 +15,7 @@ use axum::{
 #[utoipa::path(
     get,
     path = "/.well-known/openid-credential-issuer",
-    tag = "Well-known",
+    tag = "(.well-known)",
     tags = ["(public)"],
     responses(
         (status = 200, description = "Successfully returns the Credential Issuer Metadata", body = [CredentialIssuerMetadata])

diff --git a/agent_api_rest/src/lib.rs b/agent_api_rest/src/lib.rs
@@ -116,7 +116,8 @@ fn get_base_path() -> Result<String, ConfigError> {
         ),
         tags(
             (name = "(public)", description = "A collection of endpoints that should be publicly accessible without authentication. They are used to resolve metadata or allow communication with wallets."),
-            (name = "Well-known", description = "Well-known endpoints provide metadata about the server.")
+            (name = "(.well-known)", description = "Well-known endpoints provide metadata about the server."),
+            (name = "Issuance", description = "Issue credentials to holders that will store them in their wallets.", external_docs(description="Official Documentation", url="https://docs.impierce.com")),
         )
     )]
 pub struct ApiDoc;