Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Roadmap and difference to Xivapi #1

Open
5 of 8 tasks
zhyupe opened this issue Feb 14, 2023 · 1 comment
Open
5 of 8 tasks

Roadmap and difference to Xivapi #1

zhyupe opened this issue Feb 14, 2023 · 1 comment

Comments

@zhyupe
Copy link
Member

zhyupe commented Feb 14, 2023

Endpoints

  • /content
  • /{contentName}
  • /{contentName}/{contentId}
  • /search

Known problems

  • Descriptions are not formatted.
  • Transients are not merged to parent.
  • Nested property (links) are not displayed.
  • Reverse links (GameContentLinks) are not displayed.

Difference to Xivapi

  • Object depth (nested property) will be reduced from 3 to 1.
  • Some post-process params in game data api are not implemented (print_query / minify / pretty / snake_case / remove_keys).
@zhyupe
Copy link
Member Author

zhyupe commented Feb 14, 2023

Examples related to object depth changing:

Response before change

{
  "ItemIngredient0": {
    "ClassJobRepair": {
      "ItemSoulCrystal": {
        "ClassJobRepair": 0
      },
      "ItemSoulCrystalTarget": "Item",
      "ItemSoulCrystalTargetID": 10340
    },
    "ClassJobRepairTarget": "ClassJob",
    "ClassJobRepairTargetID": 11
  },
  "ItemIngredient0Target": "Item",
  "ItemIngredient0TargetID": 2121
}

Response after change

{
  "ItemIngredient0": {
    "ClassJobRepair": 11
  },
  "ItemIngredient0Target": "Item",
  "ItemIngredient0TargetID": 2121
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant