search Schemas

On this page:

searchResults

{ "$id": "searchResults", "title": "search results", "description": "The results of a search", "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "examples": [ "Forms", "The Title of the Application the result came from." ] }, "type": { "type": "string", "examples": [ "forms", "The name of the Collection the result came from" ] }, "results": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "examples": [ "912fd926-5391-48ff-b265-394d00640f4f", "The id of the result." ] }, "name": { "type": "string", "examples": [ "testForm", "Name of the result." ] }, "description": { "type": "string", "examples": [ "Hi I describe the result", "Description for the result is optional." ] }, "url": { "type": "string", "examples": [ "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f", "The shortened url to access the result from." ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "examples": [ "5c8fa4a8d8e04500b1b2f28f", "The id of the tag." ] }, "description": { "type": "string", "examples": [ "Hi I describe the tag", "Description for the tag is optional." ] }, "name": { "type": "string", "examples": [ "testTag", "Name of the tag." ] } } } } } } }, "count": { "type": "integer" } } } } } }