10833924030

Committed 12 Sep 2024 03:25PM CUT coverage: 48.864% (+0.07%) from 48.793%

Build Type

Committed by

Commit Message

ATL-7660: Credential Schema as List

Signed-off-by: Bassam Riman <bassam.riman@iohk.io>

Pull Request Pull Request #1351: feat: Support Array Of Credential Schema

Run Details

15 of 28 new or added lines in 3 files covered. (53.57%)

222 existing lines in 68 files now uncovered.

7530 of 15410 relevant lines covered (48.86%)

0.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/cloud-agent/service/server/src/main/scala/org/hyperledger/identus/agent/server/http/DocModels.scala

package org.hyperledger.identus.agent.server.http

import org.hyperledger.identus.castor.controller.{DIDEndpoints, DIDRegistrarEndpoints}
import org.hyperledger.identus.connect.controller.ConnectionEndpoints
import org.hyperledger.identus.event.controller.EventEndpoints
import org.hyperledger.identus.iam.entity.http.EntityEndpoints
import org.hyperledger.identus.iam.wallet.http.WalletManagementEndpoints
import org.hyperledger.identus.issue.controller.IssueEndpoints
import org.hyperledger.identus.pollux.credentialdefinition.CredentialDefinitionRegistryEndpoints
import org.hyperledger.identus.pollux.credentialschema.{SchemaRegistryEndpoints, VerificationPolicyEndpoints}
import org.hyperledger.identus.system.controller.SystemEndpoints
import sttp.apispec.{SecurityScheme, Tag}
import sttp.apispec.openapi.*
import sttp.model.headers.AuthenticationScheme

import scala.collection.immutable.ListMap

object DocModels {

  private val apiKeySecuritySchema = SecurityScheme(
    `type` = "apiKey",
    description = Some("API Key Authentication. The header `apikey` must be set with the API key."),
    name = Some("apikey"),
    in = Some("header"),
    scheme = None,
    bearerFormat = None,
    flows = None,
    openIdConnectUrl = None
  )

  private val adminApiKeySecuritySchema = SecurityScheme(
    `type` = "apiKey",
    description =
      Some("Admin API Key Authentication. The header `x-admin-api-key` must be set with the Admin API key."),
    name = Some("x-admin-api-key"),
    in = Some("header"),
    scheme = None,
    bearerFormat = None,
    flows = None,
    openIdConnectUrl = None
  )

  private val jwtSecurityScheme = SecurityScheme(
    `type` = "http",
    description =
      Some("JWT Authentication. The header `Authorization` must be set with the JWT token using `Bearer` scheme"),
    name = Some("Authorization"),
    in = Some("header"),
    scheme = Some(AuthenticationScheme.Bearer.name),
    bearerFormat = None,
    flows = None,
    openIdConnectUrl = None
  )

  val customiseDocsModel: OpenAPI => OpenAPI = { oapi =>
    oapi
      .openapi("3.0.3")
      .info(
        Info(
          title = "Identus Cloud Agent API Reference",
          version = "1.0", // Will be replaced dynamically by 'Tapir2StaticOAS'
          summary = None,
          description = Some("""
              |The Identus Cloud Agent API facilitates the integration and management of self-sovereign identity capabilities within applications.
              |It supports DID (Decentralized Identifiers) management, verifiable credential exchange, and secure messaging based on DIDComm standards.
              |The API is designed to be interoperable with various blockchain and DLT (Distributed Ledger Technology) platforms, ensuring wide compatibility and flexibility.
              |Key features include connection management, credential issuance and verification, and secure, privacy-preserving communication between entities.
              |Additional information and the full list of capabilities can be found in the [Open Enterprise Agent documentation](https://docs.atalaprism.io/docs/category/prism-cloud-agent)
              |""".stripMargin),
          termsOfService = None,
          contact = None,
          license = Some(
            License(
              name = "Apache 2.0",
              url = Some("https://www.apache.org/licenses/LICENSE-2.0"),
              extensions = ListMap.empty
            )
          ),
          extensions = ListMap.empty
        )
      )
      .servers(
        List(
          Server(url = "http://localhost:8085", description = Some("The local instance of the Cloud Agent")),
          Server(
            url = "http://localhost/cloud-agent",
            description = Some("The local instance of the Cloud Agent behind the APISIX proxy")
          ),
          Server(
            url = "https://k8s-dev.atalaprism.io/cloud-agent",
            description = Some("The Cloud Agent in the Staging Environment")
          ),
        )
      )
      .components(
        oapi.components
          .getOrElse(sttp.apispec.openapi.Components.Empty)
          .copy(securitySchemes =
            ListMap(
              "apiKeyAuth" -> Right(apiKeySecuritySchema),
              "adminApiKeyAuth" -> Right(adminApiKeySecuritySchema),
              "jwtAuth" -> Right(jwtSecurityScheme)
            )
          )
      )
      .addSecurity(
        ListMap(
          "apiKeyAuth" -> Vector.empty[String],
          "adminApiKeyAuth" -> Vector.empty[String],
          "jwtAuth" -> Vector.empty[String]
        )
      )
      .tags(
        List(
          ConnectionEndpoints.tag,
          IssueEndpoints.tag,
          VerificationPolicyEndpoints.tag,
          SchemaRegistryEndpoints.tag,
          CredentialDefinitionRegistryEndpoints.tag,
          DIDEndpoints.tag,
          DIDRegistrarEndpoints.tag,
          WalletManagementEndpoints.tag,
          SystemEndpoints.tag,
          EventEndpoints.tag,
          EntityEndpoints.tag
        )
      )

  }

}

1	package org.hyperledger.identus.agent.server.http
2
3	import org.hyperledger.identus.castor.controller.{DIDEndpoints, DIDRegistrarEndpoints}
4	import org.hyperledger.identus.connect.controller.ConnectionEndpoints
5	import org.hyperledger.identus.event.controller.EventEndpoints
6	import org.hyperledger.identus.iam.entity.http.EntityEndpoints
7	import org.hyperledger.identus.iam.wallet.http.WalletManagementEndpoints
8	import org.hyperledger.identus.issue.controller.IssueEndpoints
9	import org.hyperledger.identus.pollux.credentialdefinition.CredentialDefinitionRegistryEndpoints
10	import org.hyperledger.identus.pollux.credentialschema.{SchemaRegistryEndpoints, VerificationPolicyEndpoints}
11	import org.hyperledger.identus.system.controller.SystemEndpoints
12	import sttp.apispec.{SecurityScheme, Tag}
13	import sttp.apispec.openapi.*
14	import sttp.model.headers.AuthenticationScheme
15
16	import scala.collection.immutable.ListMap
17
18	object DocModels {
19
20	private val apiKeySecuritySchema = SecurityScheme(	×
21	`type` = "apiKey",
22	description = Some("API Key Authentication. The header `apikey` must be set with the API key."),
23	name = Some("apikey"),
24	in = Some("header"),
25	scheme = None,
26	bearerFormat = None,
27	flows = None,
28	openIdConnectUrl = None
29	)
30
31	private val adminApiKeySecuritySchema = SecurityScheme(	×
32	`type` = "apiKey",
33	description =
34	Some("Admin API Key Authentication. The header `x-admin-api-key` must be set with the Admin API key."),
35	name = Some("x-admin-api-key"),
36	in = Some("header"),
37	scheme = None,
38	bearerFormat = None,
39	flows = None,
40	openIdConnectUrl = None
41	)
42
43	private val jwtSecurityScheme = SecurityScheme(	×
44	`type` = "http",
45	description =
46	Some("JWT Authentication. The header `Authorization` must be set with the JWT token using `Bearer` scheme"),
47	name = Some("Authorization"),
48	in = Some("header"),
49	scheme = Some(AuthenticationScheme.Bearer.name),
50	bearerFormat = None,
51	flows = None,
52	openIdConnectUrl = None
53	)
54
55	val customiseDocsModel: OpenAPI => OpenAPI = { oapi =>
56	oapi
57	.openapi("3.0.3")	×
58	.info(	×
59	Info(
60	title = "Identus Cloud Agent API Reference",
61	version = "1.0", // Will be replaced dynamically by 'Tapir2StaticOAS'
62	summary = None,
63	description = Some("""	×
64	\|The Identus Cloud Agent API facilitates the integration and management of self-sovereign identity capabilities within applications.
65	\|It supports DID (Decentralized Identifiers) management, verifiable credential exchange, and secure messaging based on DIDComm standards.
66	\|The API is designed to be interoperable with various blockchain and DLT (Distributed Ledger Technology) platforms, ensuring wide compatibility and flexibility.
67	\|Key features include connection management, credential issuance and verification, and secure, privacy-preserving communication between entities.
68	\|Additional information and the full list of capabilities can be found in the [Open Enterprise Agent documentation](https://docs.atalaprism.io/docs/category/prism-cloud-agent)
69	\|""".stripMargin),	×
70	termsOfService = None,
71	contact = None,
72	license = Some(
73	License(
74	name = "Apache 2.0",
75	url = Some("https://www.apache.org/licenses/LICENSE-2.0"),
76	extensions = ListMap.empty	×
77	)
78	),
79	extensions = ListMap.empty	×
80	)
81	)
82	.servers(	×
83	List(	×
84	Server(url = "http://localhost:8085", description = Some("The local instance of the Cloud Agent")),	×
85	Server(	×
86	url = "http://localhost/cloud-agent",
87	description = Some("The local instance of the Cloud Agent behind the APISIX proxy")
88	),
89	Server(	×
90	url = "https://k8s-dev.atalaprism.io/cloud-agent",
91	description = Some("The Cloud Agent in the Staging Environment")
92	),
93	)
94	)
95	.components(	×
96	oapi.components
97	.getOrElse(sttp.apispec.openapi.Components.Empty)	×
98	.copy(securitySchemes =
99	ListMap(	×
100	"apiKeyAuth" -> Right(apiKeySecuritySchema),	×
101	"adminApiKeyAuth" -> Right(adminApiKeySecuritySchema),	×
102	"jwtAuth" -> Right(jwtSecurityScheme)	×
103	)
104	)
105	)
106	.addSecurity(	×
107	ListMap(	×
108	"apiKeyAuth" -> Vector.empty[String],	×
109	"adminApiKeyAuth" -> Vector.empty[String],	×
110	"jwtAuth" -> Vector.empty[String]	×
111	)
112	)
113	.tags(	×
114	List(	×
115	ConnectionEndpoints.tag,
116	IssueEndpoints.tag,
117	VerificationPolicyEndpoints.tag,
118	SchemaRegistryEndpoints.tag,
119	CredentialDefinitionRegistryEndpoints.tag,
120	DIDEndpoints.tag,
121	DIDRegistrarEndpoints.tag,
122	WalletManagementEndpoints.tag,
123	SystemEndpoints.tag,
124	EventEndpoints.tag,
125	EntityEndpoints.tag
126	)
127	)
128
129	}
130
131	}

hyperledger / identus-cloud-agent / 10833924030

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous