Knowledge Base

Update knowledge base

Changed on

Update a knowledge base's name.

Required permission:

User must have one of OWNER or WRITER on the knowledge base.

Validation:

  • kbId path parameter must be a valid UUID (updateKBSchema)
  • kbName is trimmed first, then must be 1–255 characters
  • A kbName holding an HTML tag, a javascript: URL or an inline event handler is refused with 400 before authentication; one holding a printf-style format specifier (%s, %n, %x, %p, with flags and width such as %08x) is refused with 400 by the gateway controller. A plain % (50% off) is accepted.
  • kbName is the only field read. Other body fields and any query parameter are ignored, so a body without kbName (an empty object, no body, or only unknown fields) is refused by the connector service with 400 No fields to update.
put/knowledgeBase/{kbId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/{kbId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:write

Path parameters

kbIdstring uuid required
Example:8a095180-2989-4018-b448-70eb75fba1c7

Knowledge base ID (UUID)

Request body

kbNamestring required

New name for the knowledge base. Whitespace around it is removed first, so a name made only of whitespace is refused as empty.

Example request

{
  "kbName": "Updated Documentation Hub"
}

Response

Knowledge base updated successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Knowledge base updated successfully"
}

Changes

    • breaking

      the request property became required

    • breaking

      added the pattern ^(?![\s\S]*?(?:(?<!\w)%(?:\d{1,10}\$)?[#0\-+ ]{0,10}(?:\d{1,10})?(?:\.\d{1,10})?(?:h{1,2}|l{1,2}|L|z|j|t)?[nsxXp]))[\s\S]*?\S to the request property

    • info

      added the media type application/x-www-form-urlencoded to the request body

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status