Schema Evaluation fails with "Cannot resolve schema at {uri}" about json-everything HOT 5 OPEN

@MaggieKimani1 you need to register the entire OpenAPI document under a URI identifier. Then, when you create a new schema, set its .BaseUri to the same identifier.

See this test:

This is why I suggested to you that you need to make your OpenAPIDocument type implement IBaseDocument. I created IBaseDocument explicitly to support this use case. You can also see it working in my Graeae project.

What I recommend:

1. Make OpenApiDocument implement IBaseDocument.
2. When you initialize OpenApiDocument, scan for schemas and set their .BaseUris.
3. Register the OpenApiDocument with the schema registry. (You can use either the global registry or the one in EvaluationOptions. If you use the options one, you'll need to always use those options or remember to re-register the schema with the new options.)

Then you should be able to grab any nested schema and validate with it.

If you don't do these things, then you'll end up with the schema thinking it's the root of that base URI, and it'll try to resolve pointers on the schema instead of the actual document.

from json-everything.

How exactly is your code utilizing the schema(s) inside the OpenApiDocument?

(As a side note, JsonSchema.NET is already at version 6.1.2)

from json-everything.

For what it's worth, here is an illustrative example code, modifying the schema by adding the component schemas to it. This is done because the schema reference in your example schema has an #, which indicates an embedded schema, so by making the "components" object a part of the schema object the path of the reference will resolve successfully.

var yaml = new YamlStream();
yaml.Load(... the OpenApiDocument as shown in your report ...);
var joOpenAPIDoc = (JsonObject) yaml.ToJsonNode().First();

var joSchema = (JsonObject) joOpenAPIDoc["paths"]["/issues"]["get"]["responses"]["200"]["content"]["application/json"]["schema"];
var joComponentSchemas = (JsonObject)joOpenAPIDoc["components"];

joSchema.Add("components", joComponentSchemas.DeepClone());

var schema = joSchema.Deserialize<JsonSchema>();
var result = schema.Evaluate(... the example instance ...);

(Note that the example instance you have given will not validate successfully, because it is a root object with only an "example" property. However, your schema attempts to validate a root object with a mandatory "data" property.)

from json-everything.

How exactly is your code utilizing the schema(s) inside the OpenApiDocument?

(As a side note, JsonSchema.NET is already at version 6.1.2)

We're simply loading up the document in memory, then performing validation using a set of rules for every component within the document here https://github.com/microsoft/OpenAPI.NET/blob/f069dc154ab2c6c0c7e89cc6587f2f61b356d846/src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs#L108

When it gets to the media type object and finds an example node, it tries to validate it against the schema to see if the data type matches here: https://github.com/microsoft/OpenAPI.NET/blob/e76101a582b59d94a98f6103fe05c3d908ef79ef/src/Microsoft.OpenApi/Validations/Rules/OpenApiMediaTypeRules.cs#L35

https://github.com/microsoft/OpenAPI.NET/blob/e76101a582b59d94a98f6103fe05c3d908ef79ef/src/Microsoft.OpenApi/Validations/Rules/RuleHelpers.cs#L68

from json-everything.

For what it's worth, here is an illustrative example code, modifying the schema by adding the component schemas to it. This is done because the schema reference in your example schema has an #, which indicates an embedded schema, so by making the "components" object a part of the schema object the path of the reference will resolve successfully.

var yaml = new YamlStream();
yaml.Load(... the OpenApiDocument as shown in your report ...);
var joOpenAPIDoc = (JsonObject) yaml.ToJsonNode().First();

var joSchema = (JsonObject) joOpenAPIDoc["paths"]["/issues"]["get"]["responses"]["200"]["content"]["application/json"]["schema"];
var joComponentSchemas = (JsonObject)joOpenAPIDoc["components"];

joSchema.Add("components", joComponentSchemas.DeepClone());

var schema = joSchema.Deserialize<JsonSchema>();
var result = schema.Evaluate(... the example instance ...);

(Note that the example instance you have given will not validate successfully, because it is a root object with only an "example" property. However, your schema attempts to validate a root object with a mandatory "data" property.)

Does this mean I should try dereference the schema first before performing evaluation?
I see you're replacing the embedded $ref with the component schema here before calling schema.Evaluate()?

from json-everything.