Merge pull request #702 from 0xPolygonID/PID-2356-update-issuer-node-…

…api-spec-branding chore: update api spec branding
0xPolygonID · Jul 31, 2024 · e9df46a · e9df46a
2 parents d189623 + 0d1767d
commit e9df46a
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 12 deletions.
diff --git a/api/api.yaml b/api/api.yaml
@@ -1,8 +1,8 @@
 openapi: 3.0.0
 info:
-  title: Polygon ID - Issuer
+  title: Privado ID - Issuer
   description: |
-    Documentation for the Issuer
+    Documentation for the Issuer Node
   version: "1"
 
 tags:
@@ -161,7 +161,14 @@ paths:
     post:
       summary: Create Identity
       operationId: CreateIdentity
-      description: Endpoint to create an identity
+      description: | 
+        Endpoint to create an identity to issue credentials.
+        Issuer node supports two types of keys (field `type`):
+        * BJJ Keys
+        * ETH Keys
+        
+        `authBJJCredentialStatus` field is optional and and defines how the auth core claim will be evaluated during 
+        the process to verify that it has not been revoked.
       tags:
         - Identity
       security:
@@ -314,6 +321,9 @@ paths:
     get:
       summary: Get Identity State Status
       operationId: GetStateStatus
+      description: |
+        Endpoint to get identity state status, if the identity is published or not.
+        If the status is `pendingActions` is true it means that the identity has pending actions to be published.
       security:
         - basicAuth: [ ]
       tags:
@@ -1876,7 +1886,7 @@ components:
       properties:
         qrCodeLink:
           type: string
-          example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.polygonid.me%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
+          example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.privado.id%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
         sessionID:
           $ref: '#/components/schemas/UUIDString'
 
@@ -2149,7 +2159,7 @@ components:
           type: string
         qrCodeLink:
           type: string
-          example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.polygonid.me%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
+          example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.privado.id%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
         sessionID:
           type: string
           example: ab5d5dbf-aaaa-bbbb-b983-f48afea64e05
@@ -2163,7 +2173,7 @@ components:
       properties:
         qrCode:
           type: string
-          example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.polygonid.me%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
+          example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.privado.id%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
         status:
           type: string
           example: done | pending | pendingPublish

diff --git a/api/privadoid.png b/api/privadoid.png
diff --git a/api/spec.html b/api/spec.html
@@ -1,7 +1,7 @@
 <!doctype html>
 <html>
 <head>
-    <title>Privado ID - Self Hosted Issuer</title>
+    <title>Privado ID - Issuer Node</title>
     <meta charset="utf-8">
     <link href="https://fonts.googleapis.com/css?family=Nunito" rel="stylesheet">
     <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
@@ -11,17 +11,23 @@
     id = "the-doc"
     spec-url="/static/docs/api/api.yaml"
     theme = "light"
-    regular-font = "Nunito"
-    primary-color = "#7F56D9"
+    primary-color = "#93f598"
     allow-spec-url-load = false
     allow-spec-file-load = false
     show-header = false
-    render-style = "read"
+    render-style = "focused"
+    layout = "row"
     allow-authentication = true
     sort-endpoints-by="summary"
   >
-<!--    <img slot="nav-logo" src="{logo}" style="width:50px; height:50px"/>-->
+      <img
+              slot="nav-logo"
+              src="https://docs.privado.id/img/privado_logo.svg"
+              width="100px"
+              height="100px"
+      />
   </rapi-doc>
+
   <script>
       window.addEventListener('DOMContentLoaded', () => {
           const rapidocEl = document.getElementById('the-doc');

diff --git a/internal/api/server.go b/internal/api/server.go
@@ -83,7 +83,7 @@ func documentation(w http.ResponseWriter, _ *http.Request) {
 }
 
 func favicon(w http.ResponseWriter, _ *http.Request) {
-	writeFile("api/polygon.png", "image/png", w)
+	writeFile("api/privadoid.png", "image/png", w)
 }
 
 func swagger(w http.ResponseWriter, _ *http.Request) {