games.namespaces.validateGameNamespace

Description

Validates information used to create a new game namespace.

Code Examples

Request

POST

https://api.rivet.gg/cloud/games/{game_id}/namespaces/validate

# 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'

game_id

required path parameter

display_name

required string

Represent a resource's readable display name.

name_id

required 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

required array<object>

A list of validation errors.

errors[*]

object

An error given by failed content validation.

path

required array<string>

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

path[*]

string