Skip to content

Commit 48c2b76

Browse files
pluralplural
authored
Merge pull request #295 from plural/doc-relationship-update-20240721
Update docs for new {card,printing} <-> card pool relationships.
2 parents 2caddec + 4696486 commit 48c2b76

19 files changed

+31
-27
lines changed

‎doc/api/card_pools/all_card_pools.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"resource": "Card Pools",
3-
"resource_explanation": "## Relationships\n\nCard Pool resources have the following relationships for their records.\n\n* Card Cycles\n* Card Sets\n* Format\n* Snapshots\n",
3+
"resource_explanation": "## Relationships\n\nCard Pool resources have the following relationships for their records.\n\n* Card Cycles\n* Card Sets\n* Cards\n* Format\n* Printings\n* Snapshots\n",
44
"http_method": "GET",
55
"route": "/api/v3/public/card_pools",
66
"description": "All Card Pools",
@@ -25,7 +25,7 @@
2525
"request_content_type": "application/json",
2626
"response_status": 200,
2727
"response_status_text": "OK",
28-
"response_body": "{\n \"data\": [\n {\n \"id\": \"eternal_01\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Eternal Card Pool #1\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 127\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=eternal_01\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=eternal_01\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=eternal_01\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/eternal_01\"\n }\n },\n {\n \"id\": \"startup_01\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Startup Card Pool #1\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n \"core\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=startup_01\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=startup_01\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=startup_01\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/startup_01\"\n }\n },\n {\n \"id\": \"startup_02\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Startup Card Pool #2\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n \"core\",\n \"borealis\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=startup_02\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=startup_02\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=startup_02\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/startup_02\"\n }\n },\n {\n \"id\": \"standard_01\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Standard Card Pool #1\",\n \"format_id\": \"standard\",\n \"card_cycle_ids\": [\n \"core\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/standard\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=standard_01\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=standard_01\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=standard_01\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/standard_01\"\n }\n },\n {\n \"id\": \"standard_02\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Standard Card Pool #2\",\n \"format_id\": \"standard\",\n \"card_cycle_ids\": [\n \"core\",\n \"borealis\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 8\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/standard\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=standard_02\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=standard_02\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=standard_02\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/standard_02\"\n }\n }\n ],\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"first\": \"http://localhost:3000/api/v3/public/card_pools?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"last\": \"http://localhost:3000/api/v3/public/card_pools?page%5Bnumber%5D=1&page%5Bsize%5D=20\"\n },\n \"meta\": {\n }\n}",
28+
"response_body": "{\n \"data\": [\n {\n \"id\": \"eternal_01\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Eternal Card Pool #1\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 127\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=eternal_01\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=eternal_01\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=eternal_01\"\n }\n },\n \"cards\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/cards?filter[card_pool_id]=eternal_01\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_pool_id]=eternal_01\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/eternal_01\"\n }\n },\n {\n \"id\": \"startup_01\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Startup Card Pool #1\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n \"core\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=startup_01\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=startup_01\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=startup_01\"\n }\n },\n \"cards\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/cards?filter[card_pool_id]=startup_01\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_pool_id]=startup_01\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/startup_01\"\n }\n },\n {\n \"id\": \"startup_02\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Startup Card Pool #2\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n \"core\",\n \"borealis\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=startup_02\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=startup_02\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=startup_02\"\n }\n },\n \"cards\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/cards?filter[card_pool_id]=startup_02\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_pool_id]=startup_02\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/startup_02\"\n }\n },\n {\n \"id\": \"standard_01\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Standard Card Pool #1\",\n \"format_id\": \"standard\",\n \"card_cycle_ids\": [\n \"core\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/standard\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=standard_01\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=standard_01\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=standard_01\"\n }\n },\n \"cards\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/cards?filter[card_pool_id]=standard_01\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_pool_id]=standard_01\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/standard_01\"\n }\n },\n {\n \"id\": \"standard_02\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Standard Card Pool #2\",\n \"format_id\": \"standard\",\n \"card_cycle_ids\": [\n \"core\",\n \"borealis\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 8\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/standard\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=standard_02\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=standard_02\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=standard_02\"\n }\n },\n \"cards\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/cards?filter[card_pool_id]=standard_02\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_pool_id]=standard_02\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/standard_02\"\n }\n }\n ],\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"first\": \"http://localhost:3000/api/v3/public/card_pools?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"last\": \"http://localhost:3000/api/v3/public/card_pools?page%5Bnumber%5D=1&page%5Bsize%5D=20\"\n },\n \"meta\": {\n }\n}",
2929
"response_headers": {
3030
"Content-Type": "application/vnd.api+json; charset=utf-8"
3131
},

‎doc/api/card_pools/get_a_single_card_pool.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"resource": "Card Pools",
3-
"resource_explanation": "## Relationships\n\nCard Pool resources have the following relationships for their records.\n\n* Card Cycles\n* Card Sets\n* Format\n* Snapshots\n",
3+
"resource_explanation": "## Relationships\n\nCard Pool resources have the following relationships for their records.\n\n* Card Cycles\n* Card Sets\n* Cards\n* Format\n* Printings\n* Snapshots\n",
44
"http_method": "GET",
55
"route": "/api/v3/public/card_pools/:id",
66
"description": "Get A Single Card Pool",
@@ -30,7 +30,7 @@
3030
"request_content_type": "application/json",
3131
"response_status": 200,
3232
"response_status_text": "OK",
33-
"response_body": "{\n \"data\": {\n \"id\": \"startup_02\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Startup Card Pool #2\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n \"core\",\n \"borealis\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=startup_02\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=startup_02\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=startup_02\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/startup_02\"\n }\n },\n \"meta\": {\n }\n}",
33+
"response_body": "{\n \"data\": {\n \"id\": \"startup_02\",\n \"type\": \"card_pools\",\n \"attributes\": {\n \"name\": \"Startup Card Pool #2\",\n \"format_id\": \"startup\",\n \"card_cycle_ids\": [\n \"core\",\n \"borealis\"\n ],\n \"updated_at\": \"2022-12-08T12:00:00+00:00\",\n \"num_cards\": 4\n },\n \"relationships\": {\n \"format\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/formats/startup\"\n }\n },\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[card_pool_id]=startup_02\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[card_pool_id]=startup_02\"\n }\n },\n \"snapshots\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/snapshots?filter[card_pool_id]=startup_02\"\n }\n },\n \"cards\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/cards?filter[card_pool_id]=startup_02\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_pool_id]=startup_02\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/card_pools/startup_02\"\n }\n },\n \"meta\": {\n }\n}",
3434
"response_headers": {
3535
"Content-Type": "application/vnd.api+json; charset=utf-8"
3636
},

‎doc/api/card_types/relationship_-_get_cards_for_a_card_type.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎doc/api/cards/all_cards.json

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)