Get feature configuration schema

Get a feature’s configuration schema.

GET /features/{feature}/_schema

Get feature configuration schema

Python

import requests

url = "https://{FUSION HOST}/api/features/{feature}/_schema"

response = requests.get(url)

print(response.text)

200

{
  "title": "<string>",
  "description": "<string>",
  "required": [
    "<string>"
  ],
  "properties": {},
  "additionalProperties": {},
  "minProperties": 123,
  "maxProperties": 123,
  "definitions": {},
  "category": "<string>",
  "categoryPriority": 123,
  "enum": [
    {}
  ],
  "hints": [
    "<string>"
  ],
  "unsafe": true,
  "default": {},
  "oneOf": [
    {
      "title": "<string>",
      "description": "<string>",
      "enum": [
        {}
      ],
      "default": {},
      "category": "<string>",
      "categoryPriority": 123,
      "hints": [
        "<string>"
      ],
      "unsafe": true,
      "oneOf": "<unknown>"
    }
  ],
  "propertyGroups": [
    {
      "label": "<string>",
      "properties": [
        "<string>"
      ]
    }
  ]
}

Path Parameters

feature · enum<string> · required

The feature to update. Allowed values:

• signals: Create a parallel collection for storing signals data (such as user clicks or ratings). Signals need to be indexed and aggregated before they can be used.
• recommendations: Get configuration information about recommendations. Parameters include idField (document ID field), itemsForUser (enable or disable items-for-user recommendations), itemsForQuery (enable or disable items-for-query recommendations), itemsForItem (enable or disable items-for-item recommendations), and queriesForQuery (enable or disable queries-for-query recommendations).

Available options: signals, recommendations

Response

200 - application/json

successful operation

type · enum<string> · read-only

Available options: String, Number, Integer, Boolean, Object, Array, Null, Ref

title · string · read-only

description · string · read-only

required · string[] · read-only

properties · object · read-only

Show child attributes

additionalProperties · object · read-only

minProperties · integer<int32> · read-only

maxProperties · integer<int32> · read-only

definitions · object · read-only

Show child attributes

category · string · read-only

categoryPriority · integer<int32> · read-only

enum · object[] · read-only

hints · string[] · read-only

unsafe · boolean · read-only

default · object · read-only

oneOf · object[] · read-only

Show child attributes

propertyGroups · object[] · read-only

Show child attributes