Skip to content
This repository has been archived by the owner on Jan 18, 2023. It is now read-only.

API Docs Return types wrong #347

Open
CrispyBacon1999 opened this issue Nov 19, 2019 · 1 comment
Open

API Docs Return types wrong #347

CrispyBacon1999 opened this issue Nov 19, 2019 · 1 comment
Labels
wontfix
Milestone
Future

Comments

@CrispyBacon1999
Copy link
Contributor

Describe the bug
The api docs show some of the data return types correctly, but the api doesn't match what is actually returned for some endpoints. Specifically /event/:event-key, /team/:team-key, /match/:match-key.
These endpoints return an array containing a single object instead of the documented object type.

Steps to reproduce the issue

  1. Use api/event/:event-key
  2. Look at the json data returned

Expected behavior
Endpoints should return Team, not Team[]
@ofekashery ofekashery removed the bug label Nov 28, 2019
@Techno11 Techno11 added this to the Future milestone Feb 5, 2020
@Techno11
Copy link
Collaborator

This is the intended response. To normalize the responses of the API, even single object requests return in a 1-object array. The API docs will be updated to reflect this.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
wontfix
Projects
None yet
Milestone
Future
Development

No branches or pull requests
3 participants
@CrispyBacon1999 @Techno11 @ofekashery