Skip to content

Commit ddc39ec

Browse files
mivdsclaude
andauthored
fix(docs): replace stale v3 doc links with v4 equivalents (#2786)
Customers following doc links from the main branch were landing on v3 (SodaCL / Soda Library) documentation and following the wrong process. - JSON contract schema: point the schema check description at the v4 contract language reference (#schema-check) instead of the v3 SodaCL page, and the threshold descriptions at #thresholds instead of the dead docs.soda.io/#thresholds anchor. Also drop two leftover 'YY ' prefixes in threshold descriptions. - exit_codes.py: the ExitCode docstring linked to the v3 Soda Library docs; no v4 page documents Soda Core exit codes (the sodacli page documents different semantics), so document the codes inline instead. The v3 links in the README's 'Working with legacy Soda Core v3' section are intentional and left as-is. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 6c553b5 commit ddc39ec

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

soda-core/src/soda_core/cli/exit_codes.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
class ExitCode(IntEnum):
66
"""Possible exit codes and their meaning.
77
8-
See https://docs.soda.io/soda-library/programmatic.html#scan-exit-codes
8+
0: all checks passed, no errors
9+
1: one or more checks failed
10+
2: one or more checks warned (no failures)
11+
3: errors occurred during execution (e.g. parse or engine errors)
12+
4: results could not be sent to Soda Cloud
913
"""
1014

1115
OK = 0

soda-core/src/soda_core/contracts/soda_data_contract_json_schema_1_0_0.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -680,7 +680,7 @@
680680
{
681681
"type": "object",
682682
"additionalProperties": false,
683-
"description": "Use a schema check to validate the presence, absence or position of columns in a dataset, or to validate the type of data column contains. See documentation for more details: https://docs.soda.io/soda-cl/schema.html",
683+
"description": "Use a schema check to validate the presence, absence or position of columns in a dataset, or to validate the type of data column contains. See documentation for more details: https://docs.soda.io/soda-v4/reference/contract-language-reference#schema-check",
684684
"properties": {
685685
"name": {
686686
"description": "The display name for the check used in Soda Cloud",
@@ -1121,7 +1121,7 @@
11211121
"threshold": {
11221122
"type": "object",
11231123
"additionalProperties": false,
1124-
"description": "The threshold for the check. See documentation for more details: https://docs.soda.io/#thresholds",
1124+
"description": "The threshold for the check. See documentation for more details: https://docs.soda.io/soda-v4/reference/contract-language-reference#thresholds",
11251125
"properties": {
11261126
"metric": {
11271127
"description": "The type of the metric value to check",
@@ -1131,7 +1131,7 @@
11311131
]
11321132
},
11331133
"must_be": {
1134-
"description": "YY The value the check metric (as specified in the type) must have for the check to pass; The check passes if the metric has the specified value, and fails otherwise; https://docs.soda.io/#thresholds",
1134+
"description": "The value the check metric (as specified in the type) must have for the check to pass; The check passes if the metric has the specified value, and fails otherwise; https://docs.soda.io/soda-v4/reference/contract-language-reference#thresholds",
11351135
"type": [
11361136
"number",
11371137
"string"
@@ -1296,7 +1296,7 @@
12961296
"thresholdFreshness": {
12971297
"type": "object",
12981298
"additionalProperties": false,
1299-
"description": "The threshold for the check. See documentation for more details: https://docs.soda.io/#thresholds",
1299+
"description": "The threshold for the check. See documentation for more details: https://docs.soda.io/soda-v4/reference/contract-language-reference#thresholds",
13001300
"properties": {
13011301
"unit": {
13021302
"description": "The type of the metric value to check",
@@ -1307,7 +1307,7 @@
13071307
]
13081308
},
13091309
"must_be": {
1310-
"description": "YY The value the check metric (as specified in the type) must have for the check to pass; The check passes if the metric has the specified value, and fails otherwise; https://docs.soda.io/#thresholds",
1310+
"description": "The value the check metric (as specified in the type) must have for the check to pass; The check passes if the metric has the specified value, and fails otherwise; https://docs.soda.io/soda-v4/reference/contract-language-reference#thresholds",
13111311
"type": "number"
13121312
},
13131313
"must_not_be": {

0 commit comments

Comments
 (0)