Expand documentation and comment source code by asmataamallah25 · Pull Request #99 · FIWARE/CanisMajor

asmataamallah25 · 2025-06-19T12:35:44Z

Additional documentation added
Source code commented for additional clarity

wistefan

Please use proper Javadoc.

wistefan · 2025-06-23T09:29:32Z

docs/canis_major_technical_overview.md

+    - Value: "0x0" (which is 0 in decimal)
+
+## HashiCorp Vault
+HashiCorp Vault is integrated into Canis Major to manage and protect sensitive data such as cryptographic keys and wallet credentials.


Vault is NOT integrated into CanisMajor. Its provided as an example in the test and development deployments and CAN be used.

wistefan · 2025-06-23T09:31:24Z

docs/setup.md

+
+This document outlines the prerequisites for running the Canis Major adapter without issues. The setup has been tested on an Ubuntu 22.04.1 LTS virtual machine running on FIWARE Lab. For more information on [FIWARE lab](https://www.fiware.org/developers/fiware-lab/) check the official documentation.
+
+## Java setup


Java is only a development prerequisite, not for running it. To run Canis Major, an OCI-Compliant container runtime is enough.

It depends of the type of deployment. if it is deploy using containers then you do not need Java but if you want to execute the code as it is, then you will need Java. Maybe, it should be clarify in the text.

CanisMajor as of know only supports containerized deployments. We do not even publish any other runnable.

As I said before and clarify. if you want to develop the component, there is no information in the documentation about which kind of Java version you can use. So it should be clarify in the setup.

For development, sure. But not for deployment, thats a difference

I think that we can add that:

"Java is only a development prerequisite, not for running it. To run Canis Major, an OCI-Compliant container runtime is enough."

At the beginning of the description of the section.

wistefan · 2025-06-23T09:32:25Z

docs/setup.md

+
+## Docker Setup
+
+Docker is required to run Canis Major. The following version have been tested and confirmed to work:


It does not need to be docker, any OCI-compatible runtime is sufficient. In Kubernetes environments, most likely no docker is available.

For the time been, there is neither kubernetes configuration or helm charts in the repo and no reference to helm charts in the README. We can add in the roadmap the modification of the documentation in order to link to the Helm charts and test the functionality.

wistefan · 2025-06-23T09:33:16Z

it/src/main/java/it/pojo/CMEntitesResponse.java

 @Data
 public class CMEntitesResponse {
-
+	// Represent 


Who represents what?

wistefan · 2025-06-23T09:35:14Z

it/src/main/java/it/pojo/Address.java


 import lombok.Data;

+// This class contains the field of an address


// is for inline-comments. Please use the proper javadoc style for class-doc, e.g. /** .... */

wistefan · 2025-06-23T09:35:43Z

it/src/main/java/it/pojo/EntityTransactions.java

-
-	private final String entityId;
-	private final List<Object> txDetails;
+    private final String entityId; // Unique identifier for the entity


Inline comments please above the line

wistefan · 2025-06-23T09:36:21Z

it/src/test/java/it/StepDefinitions.java

-
-	private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
-	public static final String NGSILD_TENANT = "orion";
+/* This class is a comprehensive Cucumber step definition set for integration testing Canis Major,


Doc is most likely at the wrong spot.

wistefan · 2025-06-23T09:36:56Z

it/src/test/java/it/StepDefinitions.java

 		OBJECT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 	}

+	// Canis Major and Vault service endpoints and the Vault root toke


Inline comments ALWAYS belong to the line below. The address below is only Canis Major

wistefan · 2025-06-23T09:37:35Z

src/main/java/org/fiware/canismajor/Application.java

+
 @RequiredArgsConstructor
 @Factory
+// This class is the main application class


Why did you remove the properly formatted doc with an improper one?

wistefan · 2025-06-23T09:38:10Z

src/main/java/org/fiware/canismajor/Application.java

 	private final EthereumProperties ethereumProperties;

 	@Bean
+	// This method creates a blocking HTTP client


Comments always above the annotation. Public methods should use Javadoc style, not inline comments.

asmataamallah25 and others added 18 commits November 26, 2024 14:09

Added documentation to Canis Major

63f12ba

Updated documentation

a60e7da

Address review feedback

d9b5309

Merge branch 'master' into documentation

f729e90

Merge branch 'master' into documentation

95edea3

Create canis-major-integration-guide.md

47c4f20

Update Docker compose cleanup solutions in Troubleshooting.md

c96b84c

Update setup.md

a388b44

Update canis-major-integration-guide.md

6b2a80e

Update Troubleshooting.md

7e2c288

Update Troubleshooting.md

f61459e

Update Troubleshooting.md

3aef1bd

Update canis-major-integration-guide.md

456d0ad

Update canis-major-integration-guide.md

1bd5568

Update Troubleshooting.md

201a08f

Update Troubleshooting.md

d39bf92

Comment source code and add more documentation

02ab8aa

Source code commented & Additional documentation

24037c7

asmataamallah25 requested review from flopezag, jason-fox and jicarretero June 19, 2025 12:35

Update canis_major_technical_overview.md

58c69ad

wistefan requested changes Jun 23, 2025

View reviewed changes


		This document outlines the prerequisites for running the Canis Major adapter without issues. The setup has been tested on an Ubuntu 22.04.1 LTS virtual machine running on FIWARE Lab. For more information on [FIWARE lab](https://www.fiware.org/developers/fiware-lab/) check the official documentation.

		## Java setup


		## Docker Setup

		Docker is required to run Canis Major. The following version have been tested and confirmed to work:


		import lombok.Data;

		// This class contains the field of an address

Conversation

asmataamallah25 commented Jun 19, 2025

Uh oh!

wistefan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants