docs: README and sample in API doc are updated

eclipse-tractusx · Sep 25, 2024 · 00a86d5 · 00a86d5
1 parent 8ca1b3f
commit 00a86d5
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 292 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/charts/managed-identity-wallet/README.md b/charts/managed-identity-wallet/README.md
@@ -201,7 +201,7 @@ See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command document
 | serviceAccount.create | bool | `true` | Enable creation of ServiceAccount |
 | serviceAccount.name | string | `""` | The name of the ServiceAccount to use. |
 | tolerations | list | `[]` | Tolerations configuration |
-| vcrs | object | `{"affinity":{},"autoscaling":{"enabled":false,"maxReplicas":2,"minReplicas":1,"targetCPUUtilizationPercentage":80,"targetMemoryUtilizationPercentage":80},"configName":"verifiable-credential-revocation-service","database":{"encryptionKey":{"secret":"","secretKey":"","value":""}},"env":{"APPLICATION_LOG_LEVEL":"DEBUG","APPLICATION_NAME":"verifiable-credential-revocation-service","APPLICATION_PORT":8081,"APPLICATION_PROFILE":"local","APP_LOG_LEVEL":"INFO","AUTH_SERVER_URL":"http://{{ .Release.Name }}-keycloak","DATABASE_CONNECTION_POOL_SIZE":10,"DATABASE_HOST":"managed-identity-wallet-postgresql","DATABASE_NAME":"vcrs_app","DATABASE_PORT":5432,"DATABASE_USERNAME":"vcrs","DATABASE_USE_SSL_COMMUNICATION":false,"DOMAIN_URL":"https://977d-203-129-213-107.ngrok-free.app","ENABLE_API_DOC":true,"ENABLE_SWAGGER_UI":true,"KEYCLOAK_CLIENT_ID":"miw_private_client","KEYCLOAK_PUBLIC_CLIENT_ID":"miw_public_client","KEYCLOAK_REALM":"miw_test","MIW_URL":"https://a888-203-129-213-107.ngrok-free.app","SERVICE_SECURITY_ENABLED":true,"VC_SCHEMA_LINK":"https://www.w3.org/2018/credentials/v1, https://cofinity-x.github.io/schema-registry/w3c/v1.0/BitstringStatusList.json"},"fullnameOverride":"verifiable-credential-revocation-service","host":"localhost","image":{"pullPolicy":"IfNotPresent","repository":"tractusx/verifiable-credential-revocation-service","tag":"latest"},"imagePullSecrets":[],"ingress":{"annotations":{},"className":"","enabled":false,"hosts":null,"service":{"port":8081,"type":"ClusterIP"},"tls":[]},"ingressName":"verifiable-credential-revocation-service-ingress","livenessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":60,"periodSeconds":5,"timeoutSeconds":30},"nameOverride":"verifiable-credential-revocation-service","nodeSelector":{},"podAnnotations":{},"podLabels":{},"podSecurityContext":{},"readinessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":60,"periodSeconds":30,"timeoutSeconds":30},"replicaCount":1,"resources":{},"rollingUpdate":{"enabled":true,"rollingUpdateMaxSurge":1,"rollingUpdateMaxUnavailable":0},"secretName":"verifiable-credential-revocation-service","secrets":{"DATABASE_PASSWORD":"defaultpassword","password":"defaultpassword","postgres-password":"defaultpassword"},"securityContext":{"allowPrivilegeEscalation":false},"serviceName":"verifiable-credential-revocation-service","tolerations":[],"volumeMounts":[],"volumes":[]}` | Values for Verifiable Credential Revocation Service application |
+| vcrs | object | `{"affinity":{},"autoscaling":{"enabled":false,"maxReplicas":2,"minReplicas":1,"targetCPUUtilizationPercentage":80,"targetMemoryUtilizationPercentage":80},"configName":"verifiable-credential-revocation-service","database":{"encryptionKey":{"secret":"","secretKey":"","value":""}},"env":{"APPLICATION_LOG_LEVEL":"DEBUG","APPLICATION_NAME":"verifiable-credential-revocation-service","APPLICATION_PORT":8081,"APPLICATION_PROFILE":"local","APP_LOG_LEVEL":"INFO","AUTH_SERVER_URL":"http://{{ .Release.Name }}-keycloak","DATABASE_CONNECTION_POOL_SIZE":10,"DATABASE_HOST":"managed-identity-wallet-postgresql","DATABASE_NAME":"vcrs_app","DATABASE_PORT":5432,"DATABASE_USERNAME":"vcrs","DATABASE_USE_SSL_COMMUNICATION":false,"DOMAIN_URL":"https://977d-203-129-213-107.ngrok-free.app","ENABLE_API_DOC":true,"ENABLE_SWAGGER_UI":true,"KEYCLOAK_CLIENT_ID":"miw_private_client","KEYCLOAK_PUBLIC_CLIENT_ID":"miw_public_client","KEYCLOAK_REALM":"miw_test","MIW_URL":"https://a888-203-129-213-107.ngrok-free.app","SERVICE_SECURITY_ENABLED":true,"VC_SCHEMA_LINK":"https://www.w3.org/2018/credentials/v1, https://w3id.org/vc/status-list/2021/v1"},"fullnameOverride":"verifiable-credential-revocation-service","host":"localhost","image":{"pullPolicy":"IfNotPresent","repository":"tractusx/verifiable-credential-revocation-service","tag":"latest"},"imagePullSecrets":[],"ingress":{"annotations":{},"className":"","enabled":false,"hosts":null,"service":{"port":8081,"type":"ClusterIP"},"tls":[]},"ingressName":"verifiable-credential-revocation-service-ingress","livenessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":60,"periodSeconds":5,"timeoutSeconds":30},"nameOverride":"verifiable-credential-revocation-service","nodeSelector":{},"podAnnotations":{},"podLabels":{},"podSecurityContext":{},"readinessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":60,"periodSeconds":30,"timeoutSeconds":30},"replicaCount":1,"resources":{},"rollingUpdate":{"enabled":true,"rollingUpdateMaxSurge":1,"rollingUpdateMaxUnavailable":0},"secretName":"verifiable-credential-revocation-service","secrets":{"DATABASE_PASSWORD":"defaultpassword","password":"defaultpassword","postgres-password":"defaultpassword"},"securityContext":{"allowPrivilegeEscalation":false},"serviceName":"verifiable-credential-revocation-service","tolerations":[],"volumeMounts":[],"volumes":[]}` | Values for Verifiable Credential Revocation Service application |
 | vcrs.configName | string | `"verifiable-credential-revocation-service"` | ConfigMap Name |
 | vcrs.database.encryptionKey.secret | string | `""` | Existing secret for database encryption key |
 | vcrs.database.encryptionKey.secretKey | string | `""` | Existing secret key for database encryption key |

diff --git a/charts/managed-identity-wallet/values.yaml b/charts/managed-identity-wallet/values.yaml
@@ -398,7 +398,7 @@ vcrs:
     AUTH_SERVER_URL: "http://{{ .Release.Name }}-keycloak"
     # -- Revocation application configuration
     MIW_URL: https://a888-203-129-213-107.ngrok-free.app
-    VC_SCHEMA_LINK: https://www.w3.org/2018/credentials/v1, https://cofinity-x.github.io/schema-registry/w3c/v1.0/BitstringStatusList.json
+    VC_SCHEMA_LINK: https://www.w3.org/2018/credentials/v1, https://w3id.org/vc/status-list/2021/v1
     DOMAIN_URL: https://977d-203-129-213-107.ngrok-free.app
     # Application logging configurations
     APP_LOG_LEVEL: INFO

diff --git a/docs/api/revocation-service/openapi_v001.json b/docs/api/revocation-service/openapi_v001.json
@@ -47,7 +47,7 @@
                 "statusPurpose" : "revocation",
                 "statusListIndex" : "12",
                 "statusListCredential" : "https://977d-203-129-213-107.ngrok-free.app/api/v1/revocations/credentials/BPNL000000000000/revocation/1",
-                "type" : "BitstringStatusListEntry"
+                "type" : "StatusList2021"
               }
             }
           },
@@ -122,7 +122,7 @@
                   "statusPurpose" : "revocation",
                   "statusListIndex" : "17",
                   "statusListCredential" : "https://977d-203-129-213-107.ngrok-free.app/api/v1/revocations/credentials/BPNL000000000000/revocation/1",
-                  "type" : "BitstringStatusListEntry"
+                  "type" : "StatusList2021"
                 }
               }
             }
@@ -155,7 +155,7 @@
                 "statusPurpose" : "revocation",
                 "statusListIndex" : "12",
                 "statusListCredential" : "https://977d-203-129-213-107.ngrok-free.app/api/v1/revocations/credentials/BPNL000000000000/revocation/1",
-                "type" : "BitstringStatusListEntry"
+                "type" : "StatusList2021"
               }
             }
           },
@@ -170,7 +170,7 @@
             "content" : {
               "application/json" : {
                 "example" : {
-                  "type" : "BitstringStatusListEntry",
+                  "type" : "StatusList2021",
                   "title" : "Revocation service error",
                   "status" : "409",
                   "detail" : "Credential already revoked",
@@ -240,21 +240,21 @@
                 "example" : {
                   "@context" : [
                     "https://www.w3.org/2018/credentials/v1",
-                    "https://eclipse-tractusx.github.io/schema-registry/w3c/v1.0/BitstringStatusList.json",
+                    "https://w3id.org/vc/status-list/2021/v1",
                     "https://w3id.org/security/suites/jws-2020/v1"
                   ],
                   "id" : "http://localhost/api/v1/revocations/credentials/BPNL000000000000/revocation/1",
                   "type" : [
                     "VerifiableCredential",
-                    "BitstringStatusListCredential"
+                    "StatusList2021Credential"
                   ],
                   "issuer" : "did:web:localhost:BPNL000000000000",
                   "issuanceDate" : "2024-02-05T09:39:58Z",
                   "credentialSubject" : [
                     {
                       "statusPurpose" : "revocation",
                       "id" : "http://localhost/api/v1/revocations/credentials/BPNL000000000000/revocation/1",
-                      "type" : "BitstringStatusList",
+                      "type" : "StatusList2021",
                       "encodedList" : "H4sIAAAAAAAA/wMAAAAAAAAAAAA="
                     }
                   ],