Empty object as response

I have a schema that is generating an empty object {} in the response, but it has a targetSchema defined. Here’s my schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "API",
	"type": "object",
	"definitions": {
		"user": {
			"title": "User",
			"type": "object",
			"properties": {
				"id": {
					"title": "User ID",
					"type": "number"
				},
				"firstName": {
					"title": "First Name",
					"type": "string"
				},
				"lastName": {
					"title": "Last Name",
					"type": "string"
				}
			}
		}
	},
	"links": [
		{
			"title": "Get User",
			"rel": "item",
			"type": "object",
			"description": "Retrieve a user by ID",
			"href": "/api/v1/users/{id}",
			"method": "GET",
			"targetSchema": {
				"$ref": "#/definitions/user"
			}
		}
	]
}

It seems it should be displaying a user object, or maybe I’m missing something.

[handrews]

@krystalmonolith I believe doca ignores anything without hyperschema links. It’s not intended as a data type documentation system, just an API documentation system. You could probably get it to work with non-API data types with a little tinkering, but it’s not in-scope for the project as it currently exists.

[handrews]

@pr0digi

This set of packages is being deprecated in favor of the JSON Schema Tools monorepo. Contributions are still welcome here but most work will be done on the new packages.

One of the big reasons for rewriting the Doca suite into a new set of packages was to adhere closely to the JSON Hyper-Schema specification, and make it easier to support newer drafts. This should eliminate unexpected schema behavior (except possibly when using Cloudflare-defined extensions, but hopefully we can be more clear about how those work alongside of standard schema constructs).

The new UI is still being designed, but hopefully this should be handled in it. Feel free to file at cloudflare/json-schema-tools if you want to track this specifically.