Skip to content

Fixes #258 Add clearer doc for JSON schema's default keyword #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 9, 2020
Merged

Fixes #258 Add clearer doc for JSON schema's default keyword #259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac029f0
Fixes #258 Add clearer doc for JSON schema's default keyword
mothslaw Oct 7, 2020
958fee8
Ravi's feedback
mothslaw Oct 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/docs/References/Schemas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@ Here is a JSON object that conforms to the above schema:

For much more detail on JSON schemas, including which keywords are available, what they mean, and where you can use them, see <https://json-schema.org/understanding-json-schema/>.

!!! info
Be careful when using the JSON schema keyword `default`. This keyword is commonly misunderstood. Specifically, it does not mean "If the user does not provide a value, then this default value will be auto-substituted instead", as you might expect. In fact, in JSON schemas, `default` has no semantic meaning at all! Currently, the only thing the Delphix Engine will use this for is to pre-fill widgets on the UI.


### Delphix-specific Extensions to JSON Schema

Expand Down Expand Up @@ -309,7 +312,7 @@ This will allow the plugin author to ask the user to select [environments](/Refe
"type": "string",
"format": "reference",
"referenceType": "HOST_USER",
"matches”: "env"
"matches": "env"
}
}
```
Expand Down Expand Up @@ -337,7 +340,7 @@ The `referenceType` keyword is used to specify the [reference](#reference) type.
"type": "string",
"format": "reference",
"referenceType": "HOST_USER",
"matches”: "env"
"matches": "env"
}
}
```
Expand All @@ -362,7 +365,7 @@ The `matches` keyword is used to map an [environment user](/References/Glossary.
"type": "string",
"format": "reference",
"referenceType": "HOST_USER",
"matches”: "env"
"matches": "env"
}
}
```
Expand Down