Content Quality

This describes the endpoints for the optional Content Quality add-on.

Content Quality is an optional part of FontoXML. When integrating Content Quality in the FontoXML editor, these endpoints also need to be implemented in the CMS.

POST /proxy/content-quality

Proxies all the requests including the route (excluding the '/proxy/content-quality' path, including the subsequent path), headers and query parameters with its payload to the Content Quality App endpoint.

Parameters

context (Required)

The context from which the request was made.

Parameter type

query

Model
context
editSessionToken required string Uniquely identifies the instance of FontoXML. See Invocation of the Fonto Editor for details.

Responses

Responses depend on which sub path is called. However, the proxy endpoint should return responses as is, without any modification to the HTTP status code, headers, and body.

Examples

  Proxy the Content Quality POST /api/annotate endpoint

A request made to this endpoint, with subpath /api/annotate, with the following parameters:

/proxy/content-quality/api/annotate
{
	"context": {
		"editSessionToken": "EF091CD9-DC7A-4F91-9964-21CAF0DC3DCE"
	},
	"fragments": [
		{
			"content": "<p xmlns:fcq-hints="http://schemas.fontoxml.com/content-quality/1.0/hints.xsd" fcq-hints:language="en-GB">Some content to check.</p>"
		}
	]
}

Should be proxied unmodified to:

[content-quality-url]/api/annotate
{
	"context": {
		"editSessionToken": "EF091CD9-DC7A-4F91-9964-21CAF0DC3DCE"
	},
	"fragments": [
		{
			"content": "<p xmlns:fcq-hints="http://schemas.fontoxml.com/content-quality/1.0/hints.xsd" fcq-hints:language="en-GB">Some content to check.</p>"
		}
	]
}
Was this page helpful?