Skip to content

Commit 5e0afe5

Browse files
committed
SIVA-359 Update links and version numbers
1 parent 6d1614a commit 5e0afe5

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

docs/siva3/deployment_guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The last lines of build output should look very similar to below image:
3131
```text
3232
[INFO] Reactor Summary:
3333
[INFO]
34-
[INFO] SiVa Digitally signed documents validation service 3.3.0 SUCCESS [ 2.089 s]
34+
[INFO] SiVa Digitally signed documents validation service X.X.X SUCCESS [ 2.089 s]
3535
[INFO] validation-services-parent ......................... SUCCESS [ 0.380 s]
3636
[INFO] validation-commons ................................. SUCCESS [ 13.782 s]
3737
[INFO] tsl-loader ......................................... SUCCESS [ 9.372 s]
@@ -46,7 +46,7 @@ The last lines of build output should look very similar to below image:
4646
[INFO] siva-webapp ........................................ SUCCESS [ 42.451 s]
4747
[INFO] SiVa Sample Web application ........................ SUCCESS [ 42.236 s]
4848
[INFO] SiVa Web Service integration tests ................. SUCCESS [ 18.830 s]
49-
[INFO] siva-distribution 3.3.0 ............................ SUCCESS [ 5.763 s]
49+
[INFO] siva-distribution X.X.X ............................ SUCCESS [ 5.763 s]
5050
[INFO] ------------------------------------------------------------------------
5151
[INFO] BUILD SUCCESS
5252
[INFO] ------------------------------------------------------------------------
@@ -66,7 +66,7 @@ project by issuing below commands:
6666
**First start the Siva webapp**
6767

6868
```bash
69-
./siva-parent/siva-webapp/target/siva-webapp-3.3.0.jar
69+
./siva-parent/siva-webapp/target/siva-webapp-X.X.X.jar
7070
```
7171

7272
The SiVa webapp by default runs on port **8080**.
@@ -75,7 +75,7 @@ Easiest way to test out the deployment is to run SiVa demo application and use i
7575
**Start the Demo webapp**
7676

7777
```bash
78-
./siva-parent/siva-sample-application/target/siva-sample-application-3.3.0.jar
78+
./siva-parent/siva-sample-application/target/siva-sample-application-X.X.X.jar
7979
```
8080

8181
Now point Your browser to URL: <http://localhost:9000>
@@ -115,15 +115,15 @@ WantedBy=multi-user.target
115115
```
116116

117117
Save and close the `siva-webapp.service` file.
118-
Next we need to move `siva-webapp-3.3.0.jar` into newly created `/var/apps` directory and rename to
118+
Next we need to move `siva-webapp-X.X.X.jar` into newly created `/var/apps` directory and rename to
119119
JAR file to `siva-webapp.jar`. match
120120

121121
!!! note
122122
The copied JAR filename must match option `ExecStart` in `siva-webapp.service` file
123123

124124
```bash
125125
sudo mkdir /var/apps
126-
sudo cp siva-parent/siva-webapp/target/executable/siva-webapp-3.3.0.jar /var/apps/siva-webapp.jar
126+
sudo cp siva-parent/siva-webapp/target/executable/siva-webapp-X.X.X.jar /var/apps/siva-webapp.jar
127127
```
128128

129129
Next we need to copy the `siva-webapp.service` file into `/lib/systemd/system` directory.
@@ -193,7 +193,7 @@ Now we should build the WAR file. We have created helper script with all the cor
193193
Final steps would be copying built WAR file into Tomcat `webapps` directory and starting the servlet container.
194194

195195
```bash
196-
cp siva-parent/siva-webapp/target/siva-webapp-3.3.0.war apache-tomcat-8.5.24/webapps
196+
cp siva-parent/siva-webapp/target/siva-webapp-X.X.X.war apache-tomcat-8.5.24/webapps
197197
./apache-tomcat-7.0.77/bin/catalina.sh run
198198
```
199199

docs/siva3/interfaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Validation request parameters for JSON interface are described in the table belo
117117
| signatureFiles[0].datafiles[0].filename | SignatureFiles.SignatureFile.Signature.DataFiles.DataFile.Filename | + | String | File name of the hashed data file, max length 255 characters. |
118118
| signatureFiles[0].datafiles[0].hashAlgo | SignatureFiles.SignatureFile.Signature.DataFiles.DataFile.HashAlgo | + | String | Hash algorithm used for hashing the data file (must match with algorithm in signature file). Accepted values are dependant of validation policy |
119119
| signatureFiles[0].datafiles[0].hash | SignatureFiles.SignatureFile.Signature.DataFiles.DataFile.Hash | + | String | Data file hash in Base64 encoded format. |
120-
| signaturePolicy | SignaturePolicy | - | String | Can be used to change the default signature validation policy that is used by the service. <br> See also [SiVa Validation Policy](/siva3/appendix/validation_policy) for more detailed information on given policy constraints.<br>**Possible values:** <br> POLv3 - signatures with all legal levels are accepted (i.e. QES, AdESqc and AdES, according to Regulation (EU) No 910/2014.) <br> POLv4 - the default policy. Accepted signatures depend on their type (i.e. signature, seal or unknown) and legal level (i.e. QES, AdESqc and Ades) |
120+
| signaturePolicy | SignaturePolicy | - | String | Can be used to change the default signature validation policy that is used by the service. <br> See also [SiVa Validation Policy](https://open-eid.github.io/SiVa/siva3/appendix/validation_policy) for more detailed information on given policy constraints.<br>**Possible values:** <br> POLv3 - signatures with all legal levels are accepted (i.e. QES, AdESqc and AdES, according to Regulation (EU) No 910/2014.) <br> POLv4 - the default policy. Accepted signatures depend on their type (i.e. signature, seal or unknown) and legal level (i.e. QES, AdESqc and Ades) |
121121
| reportType | ReportType | - | String | <br>**Possible values:** <br> Simple - default report type. Returns overall validation result (validationConclusion block)<br> Detailed - returns detailed information about the signatures and their validation results (validationConclusion, validationProcess and validationReportSignature. Two later ones are not supported for hashcode). <br> Diagnostic - returns diagnostic data about the information contained in the signature itself, it's revocation data and mathematical validity (validationConclusion, diagnosticData block. Last one is not support for hashcode) |
122122

123123
### Sample JSON request with mandatory parameters (datafile hashcode match verification done on integrators side)
@@ -242,7 +242,7 @@ Validation request parameters for JSON interface are described in the table belo
242242
```
243243

244244
## Validation response interface
245-
The signature validation report (i.e. the validation response) for JSON and SOAP interfaces depends on what type of validation report was requested. Data types of SOAP parameters are defined in the [SiVa WSDL document](/siva3/appendix/wsdl).
245+
The signature validation report (i.e. the validation response) for JSON and SOAP interfaces depends on what type of validation report was requested. Data types of SOAP parameters are defined in the [SiVa WSDL document](https://open-eid.github.io/SiVa/siva3/appendix/wsdl/).
246246

247247
### Validation response parameters Simple Report (successful scenario)
248248

docs/version_info.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@
1616
| 1.10 | 16.06.2021 | Risto Seene, Markus Kivisalu | SIVA 3.5 documentation additions |
1717
| 1.11 | 20.04.2022 | Aare Nurm | Roadmap added |
1818
| 1.12 | 20.05.2022 | Aare Nurm | SignedBy field description update |
19+
| 1.13 | 07.11.2022 | Aare Nurm | SIVA 3.6 documentation additions. Removal of xroad-validation-service |

0 commit comments

Comments
 (0)