Skip to content

Commit

Permalink
Merge origin/master
Browse files Browse the repository at this point in the history
  • Loading branch information
redmitry committed Mar 6, 2024
2 parents b23639d + ec9b9db commit 6565bb6
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Beacon validator for the Beacon Network

The following code validates a beacon instance to know if it is suitable to query in the ELIXIR Beacon Network. Also, it reports the schema errors that the instance might have.

## Run the script

If you want to validate your beacon you need [Apache Maven](https://maven.apache.org/index.html).

- Enter to the folder and build the code:

```
cd beacon-v2-validator-tool
mvn install
```

Once it is build, you should see a `target` directory in the `beacon-v2-validator-tool` folder. There there is the script, which need the Beacon's API endpoint for validation.

- Usage with examples:

```
java -jar neat-beacon-v2-validator.jar -f https://beacons.bsc.es/beacon/v2.0.0/
java -jar neat-beacon-v2-validator.jar -f https://beacons.bsc.es/beacon/v2.0.0/ -o report.json
```

And available parameters:

```
-h (--help) - help message
-f (--framework) - location of the beacon
-o (--output) - report output file
```

8 changes: 5 additions & 3 deletions beacon-v2-validator-tool/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Simple Beacon v2 validator

Building the **neat-beacon-v2-validator** leaves vaildator commandline tool in the **target** directory:
Building the **neat-beacon-v2-validator** leaves validator commandline tool in the **target** directory:
neat-beacon-v2-validator/beacon-v2-validator-tool/target/neat-beacon-v2-validator.jar

The tool needs the Beacon's API endpoint for validation and optionally output report file.
Expand All @@ -14,6 +14,8 @@ parameters:
-f (--framework) - location of the beacon
-o (--output) - report output file
examples:
>java -jar neat-beacon-v2-validator.jar -f https://beacon-apis-demo.ega-archive.org/api
>java -jar neat-beacon-v2-validator.jar -f https://beacon-apis-demo.ega-archive.org/api -o report.json
java -jar neat-beacon-v2-validator.jar -f https://beacon-apis-demo.ega-archive.org/api
java -jar neat-beacon-v2-validator.jar -f https://beacon-apis-demo.ega-archive.org/api -o report.json
```

0 comments on commit 6565bb6

Please sign in to comment.