Skip to content

Commit c583493

Browse files
Leong Hui Wongdmcgihtsdo
Leong Hui Wong
authored andcommitted
INFRA-13814 Align parameter description with latest docs
1 parent 0fff9c8 commit c583493

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/using-the-api.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,18 @@ The following parameters should be used:
4141
| rf2DeltaOnly | false | This is set to true when a [delta release](https://confluence.ihtsdotools.org/display/DOCGLOSS/delta+release) is being validated. This should be false if validating a [snapshot release](https://confluence.ihtsdotools.org/display/DOCGLOSS/snapshot+release). |
4242
| writeSuccesses | false | This indicates on whether the final report should list the successes. Due to the large amount of data in the international RF2 files, this should be generally set to false. |
4343
| groups | `<assertion_groups>` | The assertion groups to run as part of the validation, shown [above](#select-assertions) . You can list a different group if required, and separate multiple groups using commas. For most cases, first-time-common-edition **or** common-edition **or** common-authoring would be the ones to choose from. |
44-
| previousRelease | `<previous_release>` | Leave it empty when validating without previous release (i.e using assertion group first-time-common-edition) Otherwise enter the previous release version identified by the filename of the release you have previously uploaded (using the example above, this could be `SNOMEDCT_RF2_20200301T110000Z.zip`) |
45-
| dependencyRelease | `<dependency_release>` | The dependent International release version file name (e.g `SnomedCT_InternationalRF2_PRODUCTION_20190731T120000Z.zip`) used for validating extensions only. This is the name of the file used for the release first uploaded and listed at <http://localhost:8081/api/releases>. Note: Leave this empty when validating the international release files.|
44+
| previousRelease | `<previous_release>` | Leave it empty when validating without previous release (i.e using assertion group first-time-common-edition) Otherwise enter the previous release version identified by the filename of the release you have previously downloaded (using the example above, this could be `SNOMEDCT_RF2_20200301T110000Z.zip`) |
45+
| dependencyRelease | `<dependency_release>` | The dependent International release version file name (e.g `SnomedCT_InternationalRF2_PRODUCTION_20190731T120000Z.zip`) used for validating extensions only. Note: Leave this empty when validating International release files.|
4646
| runId | `<numeric identifier>` | Enter either the timestamp for point that this validation is being run or any numeric identifier to be used to identify the job (e.g. `2020090101`). |
47-
| storageLocation | `<sub_foldername>` | The folder where validation reports will be saved to. This needs to have a value and the rvf application must have permissions to write to this location. eg. `int/20190131/test` or `/tmp` |
47+
| storageLocation | `<sub_foldername>` | The folder where validation reports will be saved to. This needs to have a value and the rvf application must have permissions to write to this location. e.g. `int/20190131/test`|
4848

49-
Please ensure that the releases specified in the parameters (e.g. _previousRelease_, _dependencyRelease_, and _previousDependencyEffectiveTime_) are made available to RVF [as described here](download-published-releases.md).
49+
Before starting the validation job, please ensure that the release packages (.zip) specified in the parameters (i.e. _previousRelease_, _dependencyRelease_, and _previousDependencyEffectiveTime_) are downloaded [as described here](download-published-releases.md).
5050

51-
Once those have been entered, then submit the post and wait. The validation is likely to take some time but the job status can be found via the results URL. The URL of these RVF validation results can be found in the response location header parameter:
51+
Once the parameters have been entered, submit the POST request and wait. The validation is likely to take some time but the job status can be found via the results URL. The URL of these RVF validation results can be found in the response location header parameter:
5252

53-
e.g `:"location": "http://localhost:8081/api/result/201905010901?storageLocation=int/20190131/test"`
53+
e.g. `:"location": "http://localhost:8081/api/result/201905010901?storageLocation=int/20190131/test"`
5454

55-
When complete,the results report is returned, formated in JSON at the same URL.
55+
When complete,the results report is returned, formatted in JSON at the same URL.
5656

5757
Examples
5858
--------

0 commit comments

Comments
 (0)