Sign In

games.namespaces.validateGameNamespace

Description

Validates information used to create a new game namespace.

Code Examples

# Write the request body to body.json before running
curl -X POST -d '@body.json' 'https://api.rivet.gg/cloud/games/{game_id}/namespaces/validate'

Request Parameters

game_id

required path parameter

Request Body

  • display_name
    string

    Represent a resource's readable display name.

  • name_id
    string

    A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.

Response Body

  • errors
    array of objects

    A list of validation errors.

    • errors.path
      array of strings

      A list of strings denoting the origin of a validation error.