{"items":[{"type":"link","label":"Search","link":"/docs/realm/customization/search-api/openapi","routeSlug":"/docs/realm/customization/search-api/openapi","content":{"contentType":"overview","meta":{"name":"Search"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/docs/realm/customization/search-api/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/docs/realm/customization/search-api/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Redocly","url":"https://redocly.com/subscription-agreement"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://redocly.com/subscription-agreement"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/docs/realm/customization/search-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{projectUrl}","description":"Project server","variables":{"projectUrl":{"default":"redocly.com","description":"Project URL (prepend your path prefix if applicable)."}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Search (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query your project's documentation and API reference content from external tools, scripts, or integrations (for example, MCP servers or custom search UIs)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Path prefix:"]}," If your project is deployed with a path prefix (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://docs.example.com/docs/"]},"), prepend that prefix to the API paths (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/docs/_search"]},")."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For path prefix configuration, see ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/reunite/project/custom-domain#serve-from-a-subdirectory"},"children":["custom domain configuration"]},"."]}]}]}]}],"sectionId":"/docs/realm/customization/search-api/openapi"}],"sectionId":"/docs/realm/customization/search-api/openapi"}]}]}},{"type":"group","label":"Search","link":"/docs/realm/customization/search-api/openapi/search","routeSlug":"/docs/realm/customization/search-api/openapi/search","items":[{"label":"Get search results","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/customization/search-api/openapi/search/search","routeSlug":"/docs/realm/customization/search-api/openapi/search/search","metadata":{"seo":{"title":"Get search results","description":"Run a full-text search and get results grouped by category (for example, Documentation, API Reference)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search","name":"Get search results","isWebhook":false,"pointer":"/paths/~1_search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get search results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Run a full-text search and get results grouped by category (for example, Documentation, API Reference)."]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchRequest","exampleIds":["paths/~1_search/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SearchRequest","exampleIds":["paths/~1_search/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1_search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/_search","servers":[{"url":"/_mock/docs/realm/customization/search-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{projectUrl}","description":"Project server","variables":{"projectUrl":{"default":"redocly.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchRequest","exampleIds":["paths/~1_search/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400"],"pointer":"/_search","href":"search/search","openApiOperationId":"search","summary":"Get search results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/customization/search-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{projectUrl}","description":"Project server","variables":{"projectUrl":{"default":"redocly.com"}}}],"schemaId":"components/schemas/SearchRequest","exampleIds":["paths/~1_search/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchRequest","exampleIds":["paths/~1_search/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search results grouped by category.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchResponse","exampleIds":["paths/~1_search/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SearchResponse","exampleIds":["paths/~1_search/post/responses/200/content/application~1json/example"]},{"code":"400","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet field name (for example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_version"]},")."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_0"}},"schemaId":"schema_0"}],"pointer":"/paths/~1_search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchResponse","exampleIds":["paths/~1_search/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchResponse","exampleIds":["paths/~1_search/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_0","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_0"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/search"}],"panels":[]}]},"httpPath":"/_search"},{"label":"Get search facets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/realm/customization/search-api/openapi/search/searchfacets","routeSlug":"/docs/realm/customization/search-api/openapi/search/searchfacets","metadata":{"seo":{"title":"Get search facets","description":"Get facet definitions and counts for building filter UIs or refining search. Facet counts are optionally computed in the context of a search query and applied filters. Facet type can be: multi-select, select, tags, and so on, as configured in search filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchFacets","name":"Get search facets","isWebhook":false,"pointer":"/paths/~1_search-facets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get search facets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get facet definitions and counts for building filter UIs or refining search. Facet counts are optionally computed in the context of a search query and applied filters. Facet ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," can be: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multi-select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},", and so on, as configured in search filters."]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFacetsRequest","exampleIds":["paths/~1_search-facets/post/requestBody/content/application~1json/examples/allFacets","paths/~1_search-facets/post/requestBody/content/application~1json/examples/singleFacetWithQuery"]}},"schemaId":"components/schemas/SearchFacetsRequest","exampleIds":["paths/~1_search-facets/post/requestBody/content/application~1json/examples/allFacets","paths/~1_search-facets/post/requestBody/content/application~1json/examples/singleFacetWithQuery"],"pointer":"/paths/~1_search-facets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/_search-facets","servers":[{"url":"/_mock/docs/realm/customization/search-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{projectUrl}","description":"Project server","variables":{"projectUrl":{"default":"redocly.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchFacetsRequest","exampleIds":["paths/~1_search-facets/post/requestBody/content/application~1json/examples/allFacets","paths/~1_search-facets/post/requestBody/content/application~1json/examples/singleFacetWithQuery"]}},"responseCodes":["200","400"],"pointer":"/_search-facets","href":"search/searchfacets","openApiOperationId":"searchFacets","summary":"Get search facets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/realm/customization/search-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://{projectUrl}","description":"Project server","variables":{"projectUrl":{"default":"redocly.com"}}}],"schemaId":"components/schemas/SearchFacetsRequest","exampleIds":["paths/~1_search-facets/post/requestBody/content/application~1json/examples/allFacets","paths/~1_search-facets/post/requestBody/content/application~1json/examples/singleFacetWithQuery"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchFacetsRequest","exampleIds":["paths/~1_search-facets/post/requestBody/content/application~1json/examples/allFacets","paths/~1_search-facets/post/requestBody/content/application~1json/examples/singleFacetWithQuery"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet definitions with values and counts. If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]}," is set in the request, returns an array with a single facet object; otherwise returns all configured facets."]}]},"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFacetsResponse"}},"schemaId":"components/schemas/SearchFacetsResponse"},{"code":"400","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet field name (for example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_version"]},")."]}]},"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_0"}},"schemaId":"schema_0"}],"pointer":"/paths/~1_search-facets/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchFacetsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchFacetsResponse"}}},{"code":"400","schemaId":"schema_0","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_0"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/searchfacets"}],"panels":[]}]},"httpPath":"/_search-facets"}],"content":{"contentType":"group","meta":{"name":"Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search","showPageActions":true},{"nodeType":"markdoc","content":"Full-text search and facet operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/_search","summary":"Get search results","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search/search","deprecated":false},{"title":"/_search-facets","summary":"Get search facets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search/searchfacets","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/FacetFilter":{"id":"components/schemas/FacetFilter","kind":"json-schema","title":"FacetFilter","data":{"type":"object","required":["field","values"],"properties":{"field":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet field name (for example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_version"]},")."]}]}},"values":{"type":"array","items":{"type":"string"},"description":"Selected facet values."}}}},"components/schemas/SearchRequest":{"id":"components/schemas/SearchRequest","kind":"json-schema","title":"SearchRequest","data":{"type":"object","required":["query","locale"],"properties":{"query":{"type":"string","description":"Full-text search query."},"locale":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Locale code for the content to search (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["default_locale"]},")."," ","Must match a locale configured in your project. Locales are set in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," under the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/config/l10n"},"children":["l10n"]}," option."]}]}},"filter":{"type":"array","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List of facet filters. Omit or use [] for no filters."]}]},"items":{"$ref":"#/components/schemas/FacetFilter"}},"loadMore":{"type":"object","description":"For pagination within a result group.","properties":{"groupKey":{"type":"string","description":"Category key to load more results for."},"offset":{"type":"integer","description":"Offset for pagination within the group."}}}}}},"components/schemas/FacetValueCount":{"id":"components/schemas/FacetValueCount","kind":"json-schema","title":"FacetValueCount","data":{"type":"object","properties":{"value":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet value (for example: a category or product name)."]}]}},"count":{"type":"integer","description":"Number of search results that match this facet value."}}}},"components/schemas/SearchDocument":{"id":"components/schemas/SearchDocument","kind":"json-schema","title":"SearchDocument","data":{"description":"Indexed document returned in search results.","properties":{"id":{"type":"string","description":"Unique identifier of the indexed document."},"url":{"type":"string","description":"URL of the document or API operation."},"title":{"type":"string","description":"Document or page title."},"text":{"type":"string","description":"Indexed text content used for search matching."},"path":{"type":"array","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Breadcrumb path (for example: section titles) leading to this document."]}]},"items":{"type":"string"}},"redocly_category":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Documentation category (for example: Documentation, API Reference)."]}]}},"redocly_product":{"type":"string","description":"Product name when content is scoped by product."},"redocly_teams":{"type":"array","description":"Team names when content is scoped by team.","items":{"type":"string"}},"redocly_version":{"oneOf":[{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether this is the default version."}}},{"type":"string"}],"description":"Version label or version object for versioned content."},"httpMethod":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["HTTP method (for example: GET, POST) for API reference items."]}]}},"httpPath":{"type":"string","description":"HTTP path pattern for API reference items."},"apiTitle":{"type":"string","description":"Title of the API for API reference items."},"apiVersion":{"type":"string","description":"API version for API reference items."}}}},"components/schemas/SearchHighlight":{"id":"components/schemas/SearchHighlight","kind":"json-schema","title":"SearchHighlight","data":{"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Highlighted snippets; matched terms are wrapped in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<mark>"]}," tags."]}]},"properties":{"id":{"type":"string","description":"Document ID matching the result document."},"title":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Highlighted title snippet with matched terms in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<mark>"]}," tags."]}]}},"url":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["URL of the result (no highlighting)."]}]}},"text":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Highlighted content snippet with matched terms in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<mark>"]}," tags."]}]}},"redocly_category":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Category value for this result (for example: Documentation, API Reference)."]}]}},"redocly_product":{"type":"string","description":"Product value for this result when applicable."},"parameters":{"type":"array","description":"Present in API reference items."}}}},"components/schemas/SearchItem":{"id":"components/schemas/SearchItem","kind":"json-schema","title":"SearchItem","data":{"type":"object","properties":{"document":{"type":"object","description":"The indexed document (metadata and content fields).","$ref":"#/components/schemas/SearchDocument"},"highlight":{"type":"object","description":"Highlighted snippets for this result.","$ref":"#/components/schemas/SearchHighlight"}}}},"components/schemas/SearchResponse":{"id":"components/schemas/SearchResponse","kind":"json-schema","title":"SearchResponse","data":{"type":"object","properties":{"facets":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/FacetValueCount"}},"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet field names to arrays of value and count. Keys may include: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_product"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_version"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_teams"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["httpMethod"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["httpPath"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiTitle"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiVersion"]},", and any custom facet fields."]}]}},"documents":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/SearchItem"}},"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Category names (e.g. Documentation, API Reference) to arrays of search items."]}]}}}}},"components/schemas/SearchFacetsRequest":{"id":"components/schemas/SearchFacetsRequest","kind":"json-schema","title":"SearchFacetsRequest","data":{"type":"object","required":["locale"],"properties":{"locale":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Locale code (same as search)."]}]}},"field":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If set, returns only the facet for this field (with values and counts). If omitted, returns all configured facets."]}]}},"query":{"type":"string","description":"Search query; facet counts are computed in the context of this query."},"filter":{"type":"array","items":{"$ref":"#/components/schemas/FacetFilter"},"description":"Counts are computed with these filters applied."},"facetQuery":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Filter facet values using this string (for type-ahead in facet controls)."]}]}}}}},"components/schemas/FacetObject":{"id":"components/schemas/FacetObject","kind":"json-schema","title":"FacetObject","data":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the facet as shown in the UI."},"field":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet field name (for example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_product"]},")."]}]}},"type":{"type":"string","description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Facet type (for example: multi-select, select, tags) as configured in search filters."]}]}},"values":{"type":"array","description":"Available facet values with their result counts.","items":{"$ref":"#/components/schemas/FacetValueCount"}}}}},"components/schemas/SearchFacetsResponse":{"id":"components/schemas/SearchFacetsResponse","kind":"json-schema","title":"SearchFacetsResponse","data":{"type":"array","items":{"$ref":"#/components/schemas/FacetObject"},"description":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the request includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]},": array with a single facet. Otherwise all facet objects with their values."]}]}}},"schema_0":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":"URI reference that identifies the problem type.","example":"about:blank"},"title":{"type":"string","description":"Error title.","example":"Bad Request"},"status":{"type":"integer","description":"HTTP status code.","example":400},"detail":{"type":"string","description":"Human-readable message with additional error details.","example":"Invalid or missing required body fields."}},"required":["detail"]},"id":"schema_0"}},"exampleStore":{"paths/~1_search/post/requestBody/content/application~1json/example":{"value":{"query":"getting started","filter":[],"locale":"default_locale"},"id":"paths/~1_search/post/requestBody/content/application~1json/example"},"paths/~1_search/post/responses/200/content/application~1json/example":{"value":{"facets":{"redocly_category":[{"value":"Documentation","count":2},{"value":"API Reference","count":0}],"redocly_product":[],"redocly_version":[],"redocly_teams":[],"httpMethod":[],"httpPath":[],"apiTitle":[],"apiVersion":[]},"documents":{"Documentation":[{"document":{"id":"doc-1","url":"/guides/getting-started","title":"Getting started","text":"This guide walks you through the initial setup.","path":[],"redocly_category":"Documentation","redocly_product":"","redocly_teams":[],"redocly_version":{"isDefault":true}},"highlight":{"id":"doc-1","title":"Getting started","url":"/guides/getting-started","text":"This guide walks you through the <mark>getting</mark> <mark>started</mark> setup.","redocly_category":"Documentation","redocly_product":"","parameters":[]}}]}},"id":"paths/~1_search/post/responses/200/content/application~1json/example"},"paths/~1_search-facets/post/requestBody/content/application~1json/examples/allFacets":{"value":{"locale":"en"},"key":"allFacets","summary":"All facets","id":"paths/~1_search-facets/post/requestBody/content/application~1json/examples/allFacets"},"paths/~1_search-facets/post/requestBody/content/application~1json/examples/singleFacetWithQuery":{"value":{"locale":"en","field":"redocly_category","query":"api","filter":[{"field":"redocly_version","values":["v1"]}]},"key":"singleFacetWithQuery","summary":"One facet with query and filter","id":"paths/~1_search-facets/post/requestBody/content/application~1json/examples/singleFacetWithQuery"}},"securitySchemeStore":{},"servers":[{"url":"/_mock/docs/realm/customization/search-api/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://{projectUrl}","description":"Project server","variables":{"projectUrl":{"default":"redocly.com","description":"Project URL (prepend your path prefix if applicable)."}}}],"specType":"openapi"},"options":{"excludeFromSearch":true,"downloadUrls":[{"url":"/_bundle/docs/realm/customization/search-api/openapi.json?download"},{"url":"/_bundle/docs/realm/customization/search-api/openapi.yaml?download"}],"mockServer":{"url":"/_mock/docs/realm/customization/search-api/openapi","position":"first","description":"Mock server"}},"specType":"openapi","title":"Search","metadata":{}}