You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/api/cli.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,50 +14,50 @@ In these commands:
14
14
15
15
## Tracking terms
16
16
17
-
{{< configOption name="ota track" description="Track the current terms of services according to provided declarations. The declarations, snapshots and versions paths are defined in the configuration." example="npx ota track" />}}
17
+
{{< refItem name="ota track" description="Track the current terms of services according to provided declarations. The declarations, snapshots and versions paths are defined in the configuration." example="npx ota track" />}}
18
18
19
19
> Note that the snapshots and versions will be recorded at the moment the command is executed, on top of the existing local history. If a shared history already exists and the goal is to add on top of it, that history has to be downloaded before executing that command.
20
20
21
-
{{< configOption name="ota track --help" description="Show help and available options for track command" example="npx ota track --help" />}}
21
+
{{< refItem name="ota track --help" description="Show help and available options for track command" example="npx ota track --help" />}}
22
22
23
-
{{< configOption name="ota track [--services <service_id>...]" description="Track terms of specific services only" example="npx ota track --services \"Facebook\"\"LinkedIn\"" />}}
23
+
{{< refItem name="ota track [--services <service_id>...]" description="Track terms of specific services only" example="npx ota track --services \"Facebook\"\"LinkedIn\"" />}}
24
24
25
-
{{< configOption name="ota track [--services <service_id>...][--types <terms_type>...]" description="Track specific terms types of specific services only" example="npx ota track --services \"Facebook\"\"LinkedIn\" --types \"Privacy Policy\"\"Terms of Service\"" />}}
25
+
{{< refItem name="ota track [--services <service_id>...][--types <terms_type>...]" description="Track specific terms types of specific services only" example="npx ota track --services \"Facebook\"\"LinkedIn\" --types \"Privacy Policy\"\"Terms of Service\"" />}}
26
26
27
-
{{< configOption name="ota track --schedule [--services <service_id>...][--types <terms_type>...]" description="Track terms on the schedule defined in the configuration" example="npx ota track --schedule" />}}
27
+
{{< refItem name="ota track --schedule [--services <service_id>...][--types <terms_type>...]" description="Track terms on the schedule defined in the configuration" example="npx ota track --schedule" />}}
28
28
29
29
## Validating declarations
30
30
31
-
{{< configOption name="ota validate [--services <service_id>...][--types <terms_type>...]" description="Check that all declarations allow recording a snapshot and a version properly. If service IDs are provided, check only those services." example="npx ota validate --services \"Facebook\"\"LinkedIn\" --types \"Privacy Policy\"\"Terms of Service\"" />}}
31
+
{{< refItem name="ota validate [--services <service_id>...][--types <terms_type>...]" description="Check that all declarations allow recording a snapshot and a version properly. If service IDs are provided, check only those services." example="npx ota validate --services \"Facebook\"\"LinkedIn\" --types \"Privacy Policy\"\"Terms of Service\"" />}}
32
32
33
-
{{< configOption name="ota validate --schema-only [--services <service_id>...][--types <terms_type>...]" description="Check that all declarations are readable by the engine. Allows for a much faster check of declarations, but does not check that the terms are actually accessible." example="npx ota validate --schema-only --services \"Facebook\"\"LinkedIn\" --types \"Privacy Policy\"\"Terms of Service\"" />}}
33
+
{{< refItem name="ota validate --schema-only [--services <service_id>...][--types <terms_type>...]" description="Check that all declarations are readable by the engine. Allows for a much faster check of declarations, but does not check that the terms are actually accessible." example="npx ota validate --schema-only --services \"Facebook\"\"LinkedIn\" --types \"Privacy Policy\"\"Terms of Service\"" />}}
34
34
35
-
{{< configOption name="ota validate --modified" description="Run ota validate only on files that have been modified in Git" example="npx ota validate --modified" />}}
35
+
{{< refItem name="ota validate --modified" description="Run ota validate only on files that have been modified in Git" example="npx ota validate --modified" />}}
36
36
37
37
## Linting declarations
38
38
39
-
{{< configOption name="ota lint [--services <service_id>...]" description="Test the format of declarations' normalisation." example="npx ota lint --services \"Facebook\"\"LinkedIn\"" />}}
39
+
{{< refItem name="ota lint [--services <service_id>...]" description="Test the format of declarations' normalisation." example="npx ota lint --services \"Facebook\"\"LinkedIn\"" />}}
40
40
41
-
{{< configOption name="ota lint --fix [--services <service_id>...]" description="Automatically correct formatting mistakes and ensure that all declarations are standardised" example="npx ota lint --fix" />}}
41
+
{{< refItem name="ota lint --fix [--services <service_id>...]" description="Automatically correct formatting mistakes and ensure that all declarations are standardised" example="npx ota lint --fix" />}}
42
42
43
-
{{< configOption name="ota lint --modified" description="Run ota lint only on files that have been modified in Git" example="npx ota lint --modified" />}}
43
+
{{< refItem name="ota lint --modified" description="Run ota lint only on files that have been modified in Git" example="npx ota lint --modified" />}}
44
44
45
45
## Publishing dataset
46
46
47
-
{{< configOption name="ota dataset [--file <filename>]" description="Export the versions dataset into a ZIP file and publish it to GitHub releases. The dataset title and the URL of the versions repository are defined in the configuration." example="npx ota dataset --file dataset.zip" />}}
47
+
{{< refItem name="ota dataset [--file <filename>]" description="Export the versions dataset into a ZIP file and publish it to GitHub releases. The dataset title and the URL of the versions repository are defined in the configuration." example="npx ota dataset --file dataset.zip" />}}
48
48
49
49
To export the dataset into a ZIP file and publish it on GitHub releases:
50
50
51
-
{{< configOption name="ota dataset --publish [--file <filename>]" description="Export and publish dataset to GitHub releases" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --publish" />}}
51
+
{{< refItem name="ota dataset --publish [--file <filename>]" description="Export and publish dataset to GitHub releases" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --publish" />}}
52
52
53
53
The `GITHUB_TOKEN` can also be defined in a [`.env` file]({{< relref "collections/references/environment-variables" >}}).
54
54
55
55
To export, publish the dataset and remove the local copy that was created after it has been uploaded:
56
56
57
-
{{< configOption name="ota dataset --publish --remove-local-copy [--file <filename>]" description="Export, publish dataset and remove local copy after upload" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --publish --remove-local-copy" />}}
57
+
{{< refItem name="ota dataset --publish --remove-local-copy [--file <filename>]" description="Export, publish dataset and remove local copy after upload" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --publish --remove-local-copy" />}}
58
58
59
-
{{< configOption name="ota dataset --schedule [--file <filename>]" description="Schedule export, publishing and local copy removal" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --schedule --publish --remove-local-copy" />}}
59
+
{{< refItem name="ota dataset --schedule [--file <filename>]" description="Schedule export, publishing and local copy removal" example="GITHUB_TOKEN=ghp_XXXXXXXXX npx ota dataset --schedule --publish --remove-local-copy" />}}
60
60
61
61
## Exposing the collection API
62
62
63
-
{{< configOption name="ota serve" description="Start the collection Web API server. The Web API will be available under `<http://localhost>:<port>/<basePath>/<apiVersion>/<resource>`. The server port and base path are defined in the configuration." example="npx ota serve" />}}
63
+
{{< refItem name="ota serve" description="Start the collection Web API server. The Web API will be available under `<http://localhost>:<port>/<basePath>/<apiVersion>/<resource>`. The server port and base path are defined in the configuration." example="npx ota serve" />}}
Copy file name to clipboardExpand all lines: content/collections/references/configuration.md
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,14 @@ As an example, see the [production configuration file](https://github.com/OpenTe
11
11
12
12
## Options
13
13
14
-
{{< configOption
14
+
{{< refItem
15
15
name="trackingSchedule"
16
16
type="string"
17
17
description="Defines how often the engine should check for changes in terms. Uses standard cron syntax to set the schedule. By default, it runs every 12 hours at minute 30."
18
18
default="30 */12 * * *"
19
19
/>}}
20
20
21
-
{{< configOption
21
+
{{< refItem
22
22
name="collectionPath"
23
23
type="string"
24
24
description="Path to the collection's directory containing declarations directory and metadata file, relative to the engine execution location"
@@ -30,13 +30,13 @@ As an example, see the [production configuration file](https://github.com/OpenTe
30
30
31
31
The recorder section manages how versions and snapshots of terms are stored, supporting multiple storage backends.
32
32
33
-
{{< configOption
33
+
{{< refItem
34
34
name="recorder.versions.storage"
35
35
type="object"
36
36
description="Configuration for storing versions. Supports Git and MongoDB. See [Storage Repositories](#storage-repositories) for more information."
37
37
/>}}
38
38
39
-
{{< configOption
39
+
{{< refItem
40
40
name="recorder.snapshots.storage"
41
41
type="object"
42
42
description="Configuration for storing snapshots. Supports Git and MongoDB. See [Storage Repositories](#storage-repositories) for more information."
@@ -46,21 +46,21 @@ The recorder section manages how versions and snapshots of terms are stored, sup
46
46
47
47
The fetcher section configures how the engine retrieves documents from the web.
48
48
49
-
{{< configOption
49
+
{{< refItem
50
50
name="fetcher.waitForElementsTimeout"
51
51
type="number"
52
52
description="Maximum wait time for elements to appear in a page (milliseconds)."
53
53
default="10000"
54
54
/>}}
55
55
56
-
{{< configOption
56
+
{{< refItem
57
57
name="fetcher.navigationTimeout"
58
58
type="number"
59
59
description="Maximum wait time for a page to load (milliseconds)."
60
60
default="30000"
61
61
/>}}
62
62
63
-
{{< configOption
63
+
{{< refItem
64
64
name="fetcher.language"
65
65
type="string"
66
66
description="Language code (ISO 639-1) for request headers."
@@ -71,14 +71,14 @@ The fetcher section configures how the engine retrieves documents from the web.
71
71
72
72
The notifier section sets up how notifications are sent when new versions of terms are recorded.
73
73
74
-
{{< configOption
74
+
{{< refItem
75
75
name="notifier.sendInBlue.updatesListId"
76
76
type="string"
77
77
description="SendInBlue contacts list ID of persons to notify on terms updates."
78
78
default="850"
79
79
/>}}
80
80
81
-
{{< configOption
81
+
{{< refItem
82
82
name="notifier.sendInBlue.updateTemplateId"
83
83
type="string"
84
84
description="SendInBlue email template ID used for updates notifications."
@@ -89,42 +89,42 @@ The notifier section sets up how notifications are sent when new versions of ter
89
89
90
90
The logger section configures logging and error notification settings.
91
91
92
-
{{< configOption
92
+
{{< refItem
93
93
name="logger.smtp.host"
94
94
type="string"
95
95
description="SMTP server hostname."
96
96
default="smtp-relay.sendinblue.com"
97
97
/>}}
98
98
99
-
{{< configOption
99
+
{{< refItem
100
100
name="logger.smtp.username"
101
101
type="string"
102
102
description="Username for SMTP server authentication."
0 commit comments