Feat(jsonschema): simplify isRequired, look into default and defaultText
This commit is contained in:
Johannes Kirschbauer
@@ -96,12 +96,15 @@ rec {
|
||||
makeModuleInfo =
|
||||
{
|
||||
path,
|
||||
required,
|
||||
defaultText ? null,
|
||||
}:
|
||||
...
|
||||
}@attrs:
|
||||
{
|
||||
"$exportedModuleInfo" =
|
||||
{
|
||||
inherit path;
|
||||
attrs
|
||||
// {
|
||||
inherit path required;
|
||||
}
|
||||
// lib.optionalAttrs (defaultText != null) {
|
||||
inherit defaultText;
|
||||
@@ -119,13 +122,20 @@ rec {
|
||||
path ? [ ],
|
||||
}:
|
||||
let
|
||||
options' = filterInvisibleOpts (filterExcludedAttrs (clean options));
|
||||
options' = (filterInvisibleOpts (filterExcludedAttrs (clean options)));
|
||||
# parse options to jsonschema properties
|
||||
properties = lib.mapAttrs (_name: option: (parseOption' (path ++ [ _name ]) option)) options';
|
||||
properties = (lib.mapAttrs (_name: option: (parseOption' (path ++ [ _name ]) option)) options');
|
||||
# TODO: figure out how to handle if prop.anyOf is used
|
||||
isRequired = prop: !(prop ? default || prop."$exportedModuleInfo".required or false);
|
||||
requiredProps = lib.filterAttrs (_: prop: isRequired prop) properties;
|
||||
required = lib.optionalAttrs (requiredProps != { }) { required = lib.attrNames requiredProps; };
|
||||
isRequired = prop: prop."$exportedModuleInfo".required or true;
|
||||
requiredProps = lib.filterAttrs (_: prop: isRequired prop) (properties);
|
||||
|
||||
# json schema spec 6.5.3: required
|
||||
# The value of this keyword MUST be an array. Elements of this array, if any, MUST be strings, and MUST be unique.
|
||||
# ...
|
||||
# Omitting this keyword has the same behavior as an empty array.
|
||||
required = {
|
||||
required = lib.attrNames requiredProps;
|
||||
};
|
||||
header' = if addHeader then header else { };
|
||||
|
||||
# freeformType is a special type
|
||||
@@ -148,15 +158,9 @@ rec {
|
||||
}
|
||||
else
|
||||
{ };
|
||||
|
||||
# Metadata about the module that is made available to the schema via '$propagatedModuleInfo'
|
||||
exportedModuleInfo = makeModuleInfo {
|
||||
inherit path;
|
||||
};
|
||||
in
|
||||
# return jsonschema
|
||||
header'
|
||||
// exportedModuleInfo
|
||||
// required
|
||||
// {
|
||||
type = "object";
|
||||
@@ -169,287 +173,277 @@ rec {
|
||||
parseOption = parseOption' [ ];
|
||||
parseOption' =
|
||||
currentPath: option:
|
||||
let
|
||||
default = getDefaultFrom option;
|
||||
example = lib.optionalAttrs (option ? example) {
|
||||
examples =
|
||||
if (builtins.typeOf option.example) == "list" then option.example else [ option.example ];
|
||||
};
|
||||
description = lib.optionalAttrs (option ? description) {
|
||||
description = option.description.text or option.description;
|
||||
};
|
||||
exposedModuleInfo = makeModuleInfo {
|
||||
path = option.loc;
|
||||
defaultText = option.defaultText or null;
|
||||
};
|
||||
in
|
||||
# either type
|
||||
# TODO: if all nested options are excluded, the parent should be excluded too
|
||||
if
|
||||
option.type.name or null == "either" || option.type.name or null == "coercedTo"
|
||||
# return jsonschema property definition for either
|
||||
then
|
||||
# lib.trace
|
||||
(
|
||||
let
|
||||
optionsList' = [
|
||||
{
|
||||
type = option.type.nestedTypes.left or option.type.nestedTypes.coercedType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
default = (getDefaultFrom (option));
|
||||
example = lib.optionalAttrs (option ? example) {
|
||||
examples =
|
||||
if (builtins.typeOf option.example) == "list" then option.example else [ option.example ];
|
||||
};
|
||||
description = lib.optionalAttrs (option ? description) {
|
||||
description = option.description.text or option.description;
|
||||
};
|
||||
exposedModuleInfo = (
|
||||
makeModuleInfo {
|
||||
path = option.loc;
|
||||
defaultText = option.defaultText or null;
|
||||
required = !(option.defaultText or null != null || option ? default);
|
||||
default = option.default or null;
|
||||
}
|
||||
{
|
||||
type = option.type.nestedTypes.right or option.type.nestedTypes.finalType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
}
|
||||
];
|
||||
optionsList = filterExcluded optionsList';
|
||||
);
|
||||
# default =
|
||||
in
|
||||
exposedModuleInfo // default // example // description // { oneOf = map parseOption optionsList; }
|
||||
# handle nested options (not a submodule)
|
||||
# foo.bar = mkOption { type = str; };
|
||||
else if !option ? _type then
|
||||
(parseOptions option {
|
||||
addHeader = false;
|
||||
path = currentPath;
|
||||
})
|
||||
# throw if not an option
|
||||
else if option._type != "option" && option._type != "option-type" then
|
||||
throw "parseOption: not an option"
|
||||
# parse nullOr
|
||||
else if
|
||||
option.type.name == "nullOr"
|
||||
# return jsonschema property definition for nullOr
|
||||
then
|
||||
let
|
||||
nestedOption = {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
};
|
||||
in
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
oneOf = [
|
||||
{ type = "null"; }
|
||||
] ++ (lib.optional (!isExcludedOption nestedOption) (parseOption nestedOption));
|
||||
}
|
||||
# parse bool
|
||||
else if
|
||||
option.type.name == "bool"
|
||||
# return jsonschema property definition for bool
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "boolean"; }
|
||||
# parse float
|
||||
else if
|
||||
option.type.name == "float"
|
||||
# return jsonschema property definition for float
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "number"; }
|
||||
# parse int
|
||||
else if
|
||||
(option.type.name == "int" || option.type.name == "positiveInt")
|
||||
# return jsonschema property definition for int
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "integer"; }
|
||||
# TODO: Add support for intMatching in jsonschema
|
||||
# parse port type aka. "unsignedInt16"
|
||||
else if
|
||||
option.type.name == "unsignedInt16"
|
||||
|| option.type.name == "unsignedInt"
|
||||
|| option.type.name == "pkcs11"
|
||||
|| option.type.name == "intBetween"
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "integer"; }
|
||||
# parse string
|
||||
# TODO: parse more precise string types
|
||||
else if
|
||||
option.type.name == "str"
|
||||
|| option.type.name == "singleLineStr"
|
||||
|| option.type.name == "passwdEntry str"
|
||||
|| option.type.name == "passwdEntry path"
|
||||
# return jsonschema property definition for string
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# TODO: Add support for stringMatching in jsonschema
|
||||
# parse stringMatching
|
||||
else if lib.strings.hasPrefix "strMatching" option.type.name then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# TODO: Add support for separatedString in jsonschema
|
||||
else if lib.strings.hasPrefix "separatedString" option.type.name then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# parse string
|
||||
else if
|
||||
option.type.name == "path"
|
||||
# return jsonschema property definition for path
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# parse anything
|
||||
else if
|
||||
option.type.name == "anything"
|
||||
# return jsonschema property definition for anything
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = allBasicTypes; }
|
||||
# parse unspecified
|
||||
else if
|
||||
option.type.name == "unspecified"
|
||||
# return jsonschema property definition for unspecified
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = allBasicTypes; }
|
||||
# parse raw
|
||||
else if
|
||||
option.type.name == "raw"
|
||||
# return jsonschema property definition for raw
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = allBasicTypes; }
|
||||
else if
|
||||
# This is a special case for the deferred clan.service 'settings', we assume it is JSON serializable
|
||||
# To get the type of a Deferred modules we need to know the interface of the place where it is evaluated.
|
||||
# i.e. in case of a clan.service this is the interface of the service which dynamically changes depending on the service
|
||||
# We assign "type" = []
|
||||
# This means any value is valid — or like TypeScript’s unknown.
|
||||
# We can assign the type later, when we know the exact interface.
|
||||
# tsType = "unknown" is a type that we preload for json2ts, such that it gets the correct type in typescript
|
||||
(option.type.name == "deferredModule")
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { tsType = "unknown"; }
|
||||
# parse enum
|
||||
else if
|
||||
option.type.name == "enum"
|
||||
# return jsonschema property definition for enum
|
||||
then
|
||||
exposedModuleInfo
|
||||
// default
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
enum = option.type.functor.payload.values;
|
||||
}
|
||||
# parse listOf submodule
|
||||
else if
|
||||
option.type.name == "listOf" && option.type.nestedTypes.elemType.name == "submodule"
|
||||
# return jsonschema property definition for listOf submodule
|
||||
then
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "array";
|
||||
items = parseSubOptions { inherit option; };
|
||||
}
|
||||
# parse list
|
||||
else if
|
||||
(option.type.name == "listOf")
|
||||
# return jsonschema property definition for list
|
||||
then
|
||||
let
|
||||
nestedOption = {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
};
|
||||
in
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "array";
|
||||
}
|
||||
// (lib.optionalAttrs (!isExcludedOption nestedOption) { items = parseOption nestedOption; })
|
||||
# parse list of unspecified
|
||||
else if
|
||||
(option.type.name == "listOf") && (option.type.nestedTypes.elemType.name == "unspecified")
|
||||
# return jsonschema property definition for list
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "array"; }
|
||||
# parse attrsOf submodule
|
||||
else if
|
||||
option.type.name == "attrsOf" && option.type.nestedTypes.elemType.name == "submodule"
|
||||
# return jsonschema property definition for attrsOf submodule
|
||||
then
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "object";
|
||||
additionalProperties = parseSubOptions {
|
||||
inherit option;
|
||||
prefix = [ "<name>" ];
|
||||
};
|
||||
}
|
||||
# parse attrs
|
||||
else if
|
||||
option.type.name == "attrs"
|
||||
# return jsonschema property definition for attrs
|
||||
then
|
||||
default
|
||||
// (lib.recursiveUpdate exposedModuleInfo (
|
||||
lib.optionalAttrs (!default ? default) {
|
||||
"$exportedModuleInfo" = {
|
||||
required = true;
|
||||
};
|
||||
}
|
||||
))
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "object";
|
||||
additionalProperties = true;
|
||||
}
|
||||
# parse attrsOf
|
||||
# TODO: if nested option is excluded, the parent should be excluded too
|
||||
else if
|
||||
option.type.name == "attrsOf" || option.type.name == "lazyAttrsOf"
|
||||
# return jsonschema property definition for attrs
|
||||
then
|
||||
let
|
||||
nestedOption = {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
};
|
||||
in
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "object";
|
||||
additionalProperties =
|
||||
if !isExcludedOption nestedOption then
|
||||
parseOption {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
# either type
|
||||
# TODO: if all nested options are excluded, the parent should be excluded too
|
||||
if
|
||||
option.type.name or null == "either" || option.type.name or null == "coercedTo"
|
||||
# return jsonschema property definition for either
|
||||
then
|
||||
let
|
||||
optionsList' = [
|
||||
{
|
||||
type = option.type.nestedTypes.left or option.type.nestedTypes.coercedType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
}
|
||||
else
|
||||
false;
|
||||
}
|
||||
# parse submodule
|
||||
else if
|
||||
option.type.name == "submodule"
|
||||
# return jsonschema property definition for submodule
|
||||
# then (lib.attrNames (option.type.getSubOptions option.loc).opt)
|
||||
then
|
||||
(lib.recursiveUpdate exposedModuleInfo (
|
||||
if (default ? default) then
|
||||
default
|
||||
else
|
||||
{
|
||||
"$exportedModuleInfo" = {
|
||||
required = true;
|
||||
};
|
||||
}
|
||||
))
|
||||
// example
|
||||
// description
|
||||
// parseSubOptions { inherit option; }
|
||||
# throw error if option type is not supported
|
||||
else
|
||||
notSupported option;
|
||||
{
|
||||
type = option.type.nestedTypes.right or option.type.nestedTypes.finalType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
}
|
||||
];
|
||||
optionsList = filterExcluded optionsList';
|
||||
in
|
||||
exposedModuleInfo // default // example // description // { oneOf = map parseOption optionsList; }
|
||||
# handle nested options (not a submodule)
|
||||
# foo.bar = mkOption { type = str; };
|
||||
else if !option ? _type then
|
||||
(parseOptions option {
|
||||
addHeader = false;
|
||||
path = currentPath;
|
||||
})
|
||||
# throw if not an option
|
||||
else if option._type != "option" && option._type != "option-type" then
|
||||
throw "parseOption: not an option"
|
||||
# parse nullOr
|
||||
else if
|
||||
option.type.name == "nullOr"
|
||||
# return jsonschema property definition for nullOr
|
||||
then
|
||||
let
|
||||
nestedOption = {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
};
|
||||
in
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
oneOf = [
|
||||
{ type = "null"; }
|
||||
] ++ (lib.optional (!isExcludedOption nestedOption) (parseOption nestedOption));
|
||||
}
|
||||
# parse bool
|
||||
else if
|
||||
option.type.name == "bool"
|
||||
# return jsonschema property definition for bool
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "boolean"; }
|
||||
# parse float
|
||||
else if
|
||||
option.type.name == "float"
|
||||
# return jsonschema property definition for float
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "number"; }
|
||||
# parse int
|
||||
else if
|
||||
(option.type.name == "int" || option.type.name == "positiveInt")
|
||||
# return jsonschema property definition for int
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "integer"; }
|
||||
# TODO: Add support for intMatching in jsonschema
|
||||
# parse port type aka. "unsignedInt16"
|
||||
else if
|
||||
option.type.name == "unsignedInt16"
|
||||
|| option.type.name == "unsignedInt"
|
||||
|| option.type.name == "pkcs11"
|
||||
|| option.type.name == "intBetween"
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "integer"; }
|
||||
# parse string
|
||||
# TODO: parse more precise string types
|
||||
else if
|
||||
option.type.name == "str"
|
||||
|| option.type.name == "singleLineStr"
|
||||
|| option.type.name == "passwdEntry str"
|
||||
|| option.type.name == "passwdEntry path"
|
||||
# return jsonschema property definition for string
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# TODO: Add support for stringMatching in jsonschema
|
||||
# parse stringMatching
|
||||
else if lib.strings.hasPrefix "strMatching" option.type.name then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# TODO: Add support for separatedString in jsonschema
|
||||
else if lib.strings.hasPrefix "separatedString" option.type.name then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# parse string
|
||||
else if
|
||||
option.type.name == "path"
|
||||
# return jsonschema property definition for path
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "string"; }
|
||||
# parse anything
|
||||
else if
|
||||
option.type.name == "anything"
|
||||
# return jsonschema property definition for anything
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = allBasicTypes; }
|
||||
# parse unspecified
|
||||
else if
|
||||
option.type.name == "unspecified"
|
||||
# return jsonschema property definition for unspecified
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = allBasicTypes; }
|
||||
# parse raw
|
||||
else if
|
||||
option.type.name == "raw"
|
||||
# return jsonschema property definition for raw
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = allBasicTypes; }
|
||||
else if
|
||||
# This is a special case for the deferred clan.service 'settings', we assume it is JSON serializable
|
||||
# To get the type of a Deferred modules we need to know the interface of the place where it is evaluated.
|
||||
# i.e. in case of a clan.service this is the interface of the service which dynamically changes depending on the service
|
||||
# We assign "type" = []
|
||||
# This means any value is valid — or like TypeScript’s unknown.
|
||||
# We can assign the type later, when we know the exact interface.
|
||||
# tsType = "unknown" is a type that we preload for json2ts, such that it gets the correct type in typescript
|
||||
(option.type.name == "deferredModule")
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { tsType = "unknown"; }
|
||||
# parse enum
|
||||
else if
|
||||
option.type.name == "enum"
|
||||
# return jsonschema property definition for enum
|
||||
then
|
||||
exposedModuleInfo
|
||||
// default
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
enum = option.type.functor.payload.values;
|
||||
}
|
||||
# parse listOf submodule
|
||||
else if
|
||||
option.type.name == "listOf" && option.type.nestedTypes.elemType.name == "submodule"
|
||||
# return jsonschema property definition for listOf submodule
|
||||
then
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "array";
|
||||
items = parseSubOptions { inherit option; };
|
||||
}
|
||||
# parse list
|
||||
else if
|
||||
(option.type.name == "listOf")
|
||||
# return jsonschema property definition for list
|
||||
then
|
||||
let
|
||||
nestedOption = {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
};
|
||||
in
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "array";
|
||||
}
|
||||
// (lib.optionalAttrs (!isExcludedOption nestedOption) { items = parseOption nestedOption; })
|
||||
# parse list of unspecified
|
||||
else if
|
||||
(option.type.name == "listOf") && (option.type.nestedTypes.elemType.name == "unspecified")
|
||||
# return jsonschema property definition for list
|
||||
then
|
||||
exposedModuleInfo // default // example // description // { type = "array"; }
|
||||
# parse attrsOf submodule
|
||||
else if
|
||||
option.type.name == "attrsOf" && option.type.nestedTypes.elemType.name == "submodule"
|
||||
# return jsonschema property definition for attrsOf submodule
|
||||
then
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "object";
|
||||
additionalProperties = parseSubOptions {
|
||||
inherit option;
|
||||
prefix = [ "<name>" ];
|
||||
};
|
||||
}
|
||||
# parse attrs
|
||||
else if
|
||||
option.type.name == "attrs"
|
||||
# return jsonschema property definition for attrs
|
||||
then
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "object";
|
||||
additionalProperties = true;
|
||||
}
|
||||
# parse attrsOf
|
||||
# TODO: if nested option is excluded, the parent should be excluded too
|
||||
else if
|
||||
option.type.name == "attrsOf" || option.type.name == "lazyAttrsOf"
|
||||
# return jsonschema property definition for attrs
|
||||
then
|
||||
let
|
||||
nestedOption = {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
};
|
||||
in
|
||||
default
|
||||
// exposedModuleInfo
|
||||
// example
|
||||
// description
|
||||
// {
|
||||
type = "object";
|
||||
additionalProperties =
|
||||
if !isExcludedOption nestedOption then
|
||||
parseOption {
|
||||
type = option.type.nestedTypes.elemType;
|
||||
_type = "option";
|
||||
loc = option.loc;
|
||||
}
|
||||
else
|
||||
false;
|
||||
}
|
||||
# parse submodule
|
||||
else if
|
||||
option.type.name == "submodule"
|
||||
# return jsonschema property definition for submodule
|
||||
# then (lib.attrNames (option.type.getSubOptions option.loc).opt)
|
||||
then
|
||||
default // exposedModuleInfo // example // description // parseSubOptions ({ inherit option; })
|
||||
# throw error if option type is not supported
|
||||
else
|
||||
notSupported option
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user