Namespace

Update namespace

Changed on

Update the namespace by its organization-scoped ref. Slug cannot be patched.

patch/v1/organizations/{organizationRef}/namespaces/{namespaceRef}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/namespaces/{namespaceRef}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: namespace)

Request body

namestring

Name of the namespace.

logostring uri nullable

Logo of the namespace.

descriptionstring nullable

Description of the namespace.

Example request

{
  "name": "Engineering",
  "logo": "https://example.com/static/logo.png",
  "description": "Engineering team namespace"
}

Response

OK

idstring required

Unique identifier of the namespace.

slugstring required

Organization-scoped canonical kebab-case slug. Immutable after create.

namestring required

Name of the namespace.

logostring uri nullable

Logo of the namespace.

descriptionstring nullable

Description of the namespace.

project_countinteger nullable

Number of projects in the namespace when projected.

document_countinteger nullable

Number of documents in the namespace when projected.

created_atstring date-time required

Date when the namespace was created.

updated_atstring date-time nullable required

Date when the namespace was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "slug": "platform",
  "name": "Engineering",
  "logo": "https://example.com/static/logo.png",
  "description": "Engineering team namespace",
  "project_count": 4,
  "document_count": 8
}

Changes

  • 12e233bb333eRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 8a34c0b5508eRevision changes
    • 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