Remove the "includeSubcategories" query parameter from the knowledge guest documents API endpoint

Description

We are removing the includeSubcategories query parameter from the
GET /api/v2/knowledge/guest/sessions/{sessionId}/documents API endpoint

Change Category

API

Change Context

  • The backend implementation is changing to support contextual queries. We don't want to support "includeSubcategories" in the new implementation.
  • The includeSubcategories functionality (getting all documents of a category and all its subcategories) is not needed in the knowledge guest API. It was copied from the "get documents" endpoint from the authenticated knowledge API without evaluating if it was really needed.

Change Impact

It will no longer be possible to get all documents of a category and its subcategories recursively. Only documents that are directly assigned to a category will be returned with the categoryId query parameter. There is no impact to customers - this parameter is not used.

Date of Change

Nov 18, 2022

Impacted APIs

GET /api/v2/knowledge/guest/sessions/{sessionId}/documents

References

[GKC-7094]

This topic was automatically closed 62 days after the last reply. New replies are no longer allowed.