Skip to content

CreateNamespace

Description

      description: |
        Create new namespace `id`.

        During the creation process, the implementation may modify user-provided `properties`, 
        such as adding additional properties like `created_at` to user-provided properties, 
        omitting any specific property, or performing actions based on any property value.

Request Schema

    CreateNamespaceRequest:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        mode:
          type: string
          description: |
            There are three modes when trying to create a namespace,
            to differentiate the behavior when a namespace of the same name already exists:
              * CREATE: the operation fails with 400.
              * EXIST_OK: the operation succeeds and the existing namespace is kept.
              * OVERWRITE: the existing namespace is dropped and a new empty namespace with this name is created.
          enum:
            - CREATE
            - EXIST_OK
            - OVERWRITE
        properties:
          type: object
          additionalProperties:
            type: string

Response Schema

    CreateNamespaceResponse:
      type: object
      properties:
        properties:
          description: |
            Properties after the namespace is created.

            If the server does not support namespace properties, it should return null for this field.
            If namespace properties are supported, but none are set, it should return an empty object.
          type: object
          additionalProperties:
            type: string