Comments (6)
omissis
commented on September 27, 2024
hi @beyer-stefan can you please share the command you are using (including all the flags and masking the base paths of your filesystem) please?
What version of go-jsonschema were you using?
from go-jsonschema.
ytjohn
commented on September 27, 2024
I am running into a very similar issue with netbox schema, and found this issue. I replicated @beyer-stefan 's issue using v0.15.0.
wget https://raw.githubusercontent.com/CVEProject/cve-schema/master/schema/v5.0/docs/CVE_JSON_5.0_bundled.json
go-jsonschema -p cve CVE_JSON_5.0_bundled.json Produces this error:
go-jsonschema: Failed: could not generate type for field "metrics": could not generate type for field "cvssV2_0": could not generate type for field "accessComplexity": definition does not exist in schema: "metrics/items/properties/cvssV2_0/definitions/accessComplexityType" (from ref "#/definitions/metrics/items/properties/cvssV2_0/definitions/accessComplexityType")
The definition does exist.
cat CVE_JSON_5.0_bundled.json | jq '.definitions.metrics.items.properties.cvssV2_0.definitions.accessComplexityType'
{
"type": "string",
"enum": [
"HIGH",
"MEDIUM",
"LOW"
]
}
from go-jsonschema.
ytjohn
commented on September 27, 2024
My issue with the netbox schema may be related.
wget https://raw.githubusercontent.com/netbox-community/devicetype-library/master/schema/generated_schema.json
wget https://raw.githubusercontent.com/netbox-community/devicetype-library/master/schema/components.jsonIf you do go-jsonschema -p netbox generated_schema.json -o netbox.go that works fine and produces code for ConsolePort
type ConsolePort struct {
// Type corresponds to the JSON schema field "type".
Type *ConsolePortType `json:"type,omitempty" yaml:"type,omitempty" mapstructure:"type,omitempty"`
}
type ConsolePortType string
const ConsolePortTypeDb25 ConsolePortType = "db-25"But if you do the same for components.json, which references that console-port in generated_schema.json, it fails. I did wonder if the dash in netbox's schema was an issue (requires extra quotes with jq command), but I removed all the dashes and got a dashless version of the same error.
go-jsonschema -p netbox components.jsonProduces error:
go-jsonschema: Failed: could not generate type for field "type": definition does not exist in schema: "console-port/properties/type" (from ref "generated_schema.json#/definitions/console-port/properties/type")
$ cat generated_schema.json| jq '.definitions."console-port".properties'
{
"type": {
"type": "string",
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
]
}
}
from go-jsonschema.
omissis
commented on September 27, 2024
@ytjohn thanks for taking the time to investigate! I will look into it 🙏
from go-jsonschema.
ytjohn
commented on September 27, 2024
I poked at this a bit more today. It seems like it's the depth level.
In the netbox-comunity schema, if I rewrite generated_schema.json like so
"type": "string",
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
]
},
"console-port": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/console-port-properties"
}
}
},
"console-server-port": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/console-port-properties"
}
}
},
And in components.json I would repoint the references, I can read these and move forward. Of course, I'd have to do this to every second level down.
"definitions": {
"console-port": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"type": {
"$ref": "generated_schema.json#/definitions/console-port-properties"
},
"poe": {
"type": "boolean"
}
},
"required": [
"name",
"type"
]
},
"console-server-port": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"type": {
"$ref": "file://generated_schema.json#/definitions/console-port-properties"
}
},
"required": [
"name",
"type"
]
},from go-jsonschema.
ytjohn
commented on September 27, 2024
Hello again. Thanks this great library. I now realize this is a known issue, or the very least, related to a known issue.
From the README, nested names aren't supported yet.
References against nested names: #/$defs/someName/$defs/someOtherName
I thought this meant included a nested def from somewhere else in the file. But - it does seem to apply equally well to properties. And indeed in the code, there is a TODO item for this. The top level names work, but properties is part of a sub-path.
I wrote some rather horrible code for properties. This works "for me", but seems like the wrong approach (splitting the string).
// TODO: Support nested definitions.
var ok bool
// handle properties as a definition name
if strings.Contains(defName, "/properties/") {
defName, propName := defName[:strings.Index(defName, "/properties/")], defName[strings.Index(defName, "/properties/")+len("/properties/"):]
if def, ok = schema.Definitions[defName]; ok {
// this means we got the definition, but we need to get the property
// we should also do modify the error message if it's the property that is missing
def, ok = def.Properties[propName]
}
} else {
def, ok = schema.Definitions[defName]
}
if !ok {
return nil, fmt.Errorf("%w: %q (from ref %q)", errDefinitionDoesNotExistInSchema, defName, ref)
}
from go-jsonschema.
Related Issues (20)
- Fails to generate schema for github-workflow HOT 3
- Go install complains on go.mod HOT 4
- `maxLength` is not working as expected according to the jsonschema docs HOT 3
- Generated Unmarshal for fields with `time.Time` HOT 6
- How to specify a root directory for `$ref` resolution? HOT 1
- feat: Use of project as package
- Nested struct support? HOT 1
- Fails to generate for Signal K, cannot generate referenced type. HOT 1
- Nullable nested object support
- Incorrect string length validation for some strings. HOT 1
- Does not generate anything for the GeoJson schema
- improve support for additionalProperties HOT 1
- Problems generating structs from schema. HOT 1
- No option to indicate an empty value for optional array field
- Feature request: string pattern validation HOT 5
- Add support for `MarshalJSON` HOT 4
- A generated `AdditionalProperties` doesn't have a struct tag HOT 3
- Go module import path needs an update after repo move HOT 2
- Validation breaks unmarhalling into non-empty struct
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from go-jsonschema.