Crecard 1.0.0 documentation

Crecard 1.0.0

That card game.

Operations

PUB combats/{combat_id}

combat_id

required

string

uid: combat_id

ID of the combat

"53307860c3599d1de448e19d"

Accepts the following message:

hello

object

uid: combat

Examples

{
  "code": "string",
  "ruleset_code": "string",
  "seq_no": 0,
  "sequence": [
    "string"
  ],
  "players": [
    {
      "code": "string",
      "name": "string",
      "role_code": "string",
      "attributes": {
        "property1": null,
        "property2": null
      },
      "piles": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    }
  ]
}

This example has been generated automatically.

SUB combats/{combat_id}

Accepts the following message:

hello

object

uid: combat

Examples

{
  "code": "string",
  "ruleset_code": "string",
  "seq_no": 0,
  "sequence": [
    "string"
  ],
  "players": [
    {
      "code": "string",
      "name": "string",
      "role_code": "string",
      "attributes": {
        "property1": null,
        "property2": null
      },
      "piles": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    }
  ]
}

This example has been generated automatically.

Schemas

object
uid: attribute
code
string
name
string
Additional properties are allowed.
object
uid: card
code
string
name
string
description
string
array<object>
attribute_code
string
value
integer
array<object>
attribute_code
string
value
integer
array<object>
range
string
Allowed values:
"single"
"all"
"random"
side
string
Allowed values:
"myself"
"enemies"
"friends"
"others"
"all"
array<object>
on
string
Allowed values:
"board"
"hand"
"removed"
"unused"
"used"
when
string
Allowed values:
"after_shuffle_pile"
"after_draw_card"
"before_play_card"
"after_play_card"
"attribute_changed"
action
string
Allowed values:
"change_attribute"
target
integer
object
string => integer

Additional properties:
integer
Additional properties are allowed.
object
uid: role
code
string
name
string
array<string>
Items:
string
array<object>
attribute_code
string
value
integer
array<object>
card_code
string
amount
integer
Additional properties are allowed.
object
uid: player
code
string
name
string
role_code
string
object
attribute_code => value

Additional properties:
any
object
pile type => card codes

array<string>
Items:
string
Additional properties are allowed.
object
uid: combat
code
string
ruleset_code
string
seq_no
number
array<string>
Items:
string
array<object>
uid: player
code
string
name
string
role_code
string
object
attribute_code => value

Additional properties:
any
object
pile type => card codes

array<string>
Items:
string
Additional properties are allowed.