Skip to content

Commit aa28a3d

Browse files
pluralplural
authored
Merge pull request #309 from plural/regenerate-docs-with-reviews
Regenerate API docs with reviews.
2 parents 88c4760 + 1a81a36 commit aa28a3d

10 files changed

+158
-10
lines changed

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

+1-1
Large diffs are not rendered by default.

‎doc/api/cards/all_cards.json

+2-2
Large diffs are not rendered by default.

‎doc/api/cards/filter_-_card_search_operator.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"resource": "Cards",
3-
"resource_explanation": "## Relationships\n\nCard resources have the following relationships for their records.\n\n* Card Cycles\n* Card Pools\n* Card Sets\n* Card Subtypes (if not present, the relationship link will filter for a 'none' value and return an empty set)\n* Card Type\n* Decklists\n* Faction\n* Printings\n* Rulings\n* Side\n",
3+
"resource_explanation": "## Relationships\n\nCard resources have the following relationships for their records.\n\n* Card Cycles\n* Card Pools\n* Card Sets\n* Card Subtypes (if not present, the relationship link will filter for a 'none' value and return an empty set)\n* Card Type\n* Decklists\n* Faction\n* Printings\n* Reviews\n* Rulings\n* Side\n",
44
"http_method": "GET",
55
"route": "/api/v3/public/cards?filter[search]=:query",
66
"description": "Filter - Card Search Operator",
@@ -33,7 +33,7 @@
3333
"request_content_type": "application/json",
3434
"response_status": 200,
3535
"response_status_text": "OK",
36-
"response_body": "{\n \"data\": [\n {\n \"id\": \"sure_gamble\",\n \"type\": \"cards\",\n \"attributes\": {\n \"stripped_title\": \"Sure Gamble\",\n \"title\": \"Sure Gamble\",\n \"card_type_id\": \"event\",\n \"side_id\": \"runner\",\n \"faction_id\": \"neutral_runner\",\n \"cost\": \"5\",\n \"advancement_requirement\": null,\n \"agenda_points\": null,\n \"base_link\": null,\n \"deck_limit\": 3,\n \"in_restriction\": false,\n \"influence_cost\": 0,\n \"influence_limit\": null,\n \"memory_cost\": null,\n \"minimum_deck_size\": null,\n \"num_printings\": 2,\n \"printing_ids\": [\n \"01050\",\n \"01064\"\n ],\n \"date_release\": \"2012-09-06\",\n \"restriction_ids\": [\n\n ],\n \"strength\": null,\n \"stripped_text\": \"Gain 9 credits.\",\n \"text\": \"Gain 9[credit].\",\n \"trash_cost\": null,\n \"is_unique\": false,\n \"card_subtype_ids\": [\n\n ],\n \"display_subtypes\": null,\n \"attribution\": null,\n \"updated_at\": \"2024-07-28T20:37:49+00:00\",\n \"format_ids\": [\n \"eternal\",\n \"standard\",\n \"startup\"\n ],\n \"card_pool_ids\": [\n \"eternal_01\",\n \"standard_01\",\n \"standard_02\",\n \"startup_01\",\n \"startup_02\"\n ],\n \"snapshot_ids\": [\n \"eternal_01\",\n \"standard_01\",\n \"standard_02\",\n \"standard_03\",\n \"standard_04\",\n \"standard_05\",\n \"startup_01\",\n \"startup_02\"\n ],\n \"card_cycle_ids\": [\n \"core\",\n \"core\"\n ],\n \"card_set_ids\": [\n \"core\",\n \"core\"\n ],\n \"designed_by\": null,\n \"printings_released_by\": [\n \"\"\n ],\n \"pronouns\": null,\n \"pronunciation_approximation\": null,\n \"pronunciation_ipa\": null,\n \"card_abilities\": {\n \"additional_cost\": false,\n \"advanceable\": false,\n \"gains_subroutines\": false,\n \"interrupt\": false,\n \"link_provided\": null,\n \"mu_provided\": null,\n \"num_printed_subroutines\": null,\n \"on_encounter_effect\": false,\n \"performs_trace\": false,\n \"recurring_credits_provided\": null,\n \"rez_effect\": false,\n \"trash_ability\": false\n },\n \"restrictions\": {\n \"banned\": [\n\n ],\n \"global_penalty\": [\n\n ],\n \"points\": {\n },\n \"restricted\": [\n\n ],\n \"universal_faction_cost\": {\n }\n },\n \"latest_printing_id\": \"01050\"\n },\n \"relationships\": {\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[id]=core,core\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[id]=core,core\"\n }\n },\n \"card_subtypes\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_subtypes?filter[id]=none\"\n }\n },\n \"card_type\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_types/event\"\n }\n },\n \"faction\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/factions/neutral_runner\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_id]=sure_gamble\"\n }\n },\n \"rulings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/rulings?filter[card_id]=sure_gamble\"\n }\n },\n \"side\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/sides/runner\"\n }\n },\n \"decklists\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/decklists?filter[card_id]=sure_gamble\"\n }\n },\n \"card_pools\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_pools?filter[card_id]=sure_gamble\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/cards/sure_gamble\"\n }\n }\n ],\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/cards?filter%5Bsearch%5D=gamble&page%5Bnumber%5D=1&page%5Bsize%5D=1000\",\n \"first\": \"http://localhost:3000/api/v3/public/cards?filter%5Bsearch%5D=gamble&page%5Bnumber%5D=1&page%5Bsize%5D=1000\",\n \"last\": \"http://localhost:3000/api/v3/public/cards?filter%5Bsearch%5D=gamble&page%5Bnumber%5D=1&page%5Bsize%5D=1000\"\n },\n \"meta\": {\n }\n}",
36+
"response_body": "{\n \"data\": [\n {\n \"id\": \"sure_gamble\",\n \"type\": \"cards\",\n \"attributes\": {\n \"stripped_title\": \"Sure Gamble\",\n \"title\": \"Sure Gamble\",\n \"card_type_id\": \"event\",\n \"side_id\": \"runner\",\n \"faction_id\": \"neutral_runner\",\n \"cost\": \"5\",\n \"advancement_requirement\": null,\n \"agenda_points\": null,\n \"base_link\": null,\n \"deck_limit\": 3,\n \"in_restriction\": false,\n \"influence_cost\": 0,\n \"influence_limit\": null,\n \"memory_cost\": null,\n \"minimum_deck_size\": null,\n \"num_printings\": 2,\n \"printing_ids\": [\n \"01050\",\n \"01064\"\n ],\n \"date_release\": \"2012-09-06\",\n \"restriction_ids\": [\n\n ],\n \"strength\": null,\n \"stripped_text\": \"Gain 9 credits.\",\n \"text\": \"Gain 9[credit].\",\n \"trash_cost\": null,\n \"is_unique\": false,\n \"card_subtype_ids\": [\n\n ],\n \"display_subtypes\": null,\n \"attribution\": null,\n \"updated_at\": \"2024-08-11T15:23:46+00:00\",\n \"format_ids\": [\n \"eternal\",\n \"standard\",\n \"startup\"\n ],\n \"card_pool_ids\": [\n \"eternal_01\",\n \"standard_01\",\n \"standard_02\",\n \"startup_01\",\n \"startup_02\"\n ],\n \"snapshot_ids\": [\n \"eternal_01\",\n \"standard_01\",\n \"standard_02\",\n \"standard_03\",\n \"standard_04\",\n \"standard_05\",\n \"startup_01\",\n \"startup_02\"\n ],\n \"card_cycle_ids\": [\n \"core\",\n \"core\"\n ],\n \"card_set_ids\": [\n \"core\",\n \"core\"\n ],\n \"designed_by\": null,\n \"printings_released_by\": [\n \"\"\n ],\n \"pronouns\": null,\n \"pronunciation_approximation\": null,\n \"pronunciation_ipa\": null,\n \"card_abilities\": {\n \"additional_cost\": false,\n \"advanceable\": false,\n \"gains_subroutines\": false,\n \"interrupt\": false,\n \"link_provided\": null,\n \"mu_provided\": null,\n \"num_printed_subroutines\": null,\n \"on_encounter_effect\": false,\n \"performs_trace\": false,\n \"recurring_credits_provided\": null,\n \"rez_effect\": false,\n \"trash_ability\": false\n },\n \"restrictions\": {\n \"banned\": [\n\n ],\n \"global_penalty\": [\n\n ],\n \"points\": {\n },\n \"restricted\": [\n\n ],\n \"universal_faction_cost\": {\n }\n },\n \"latest_printing_id\": \"01050\"\n },\n \"relationships\": {\n \"card_cycles\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_cycles?filter[id]=core,core\"\n }\n },\n \"card_sets\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_sets?filter[id]=core,core\"\n }\n },\n \"card_subtypes\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_subtypes?filter[id]=none\"\n }\n },\n \"card_type\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_types/event\"\n }\n },\n \"faction\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/factions/neutral_runner\"\n }\n },\n \"printings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/printings?filter[card_id]=sure_gamble\"\n }\n },\n \"rulings\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/rulings?filter[card_id]=sure_gamble\"\n }\n },\n \"reviews\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/reviews?filter[card_id]=sure_gamble\"\n }\n },\n \"side\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/sides/runner\"\n }\n },\n \"decklists\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/decklists?filter[card_id]=sure_gamble\"\n }\n },\n \"card_pools\": {\n \"links\": {\n \"related\": \"http://localhost:3000/api/v3/public/card_pools?filter[card_id]=sure_gamble\"\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/cards/sure_gamble\"\n }\n }\n ],\n \"links\": {\n \"self\": \"http://localhost:3000/api/v3/public/cards?filter%5Bsearch%5D=gamble&page%5Bnumber%5D=1&page%5Bsize%5D=1000\",\n \"first\": \"http://localhost:3000/api/v3/public/cards?filter%5Bsearch%5D=gamble&page%5Bnumber%5D=1&page%5Bsize%5D=1000\",\n \"last\": \"http://localhost:3000/api/v3/public/cards?filter%5Bsearch%5D=gamble&page%5Bnumber%5D=1&page%5Bsize%5D=1000\"\n },\n \"meta\": {\n }\n}",
3737
"response_headers": {
3838
"Content-Type": "application/vnd.api+json; charset=utf-8"
3939
},

0 commit comments

Comments
 (0)