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

Remove the "response type indication" from Example Value in Swagger UI #438

Closed
Scrin opened this issue Jun 8, 2017 · 3 comments
Closed

Comments

@Scrin
Copy link

Scrin commented Jun 8, 2017

Currently the Example Value on the ESI page wraps the example response in a { "application/json": value } to indicate that this is the example response for JSON content type. Since ESI only speaks JSON, this is kind of redundant.

For example the https://esi.tech.ccp.is/latest/#!/Universe/get_universe_races Example Value is as follows:

{
  "application/json": [
    {
      "alliance_id": 500001,
      "description": "Founded on the tenets of patriotism and hard work...",
      "name": "Caldari",
      "race_id": 1
    }
  ]
}

This could be replaced with the following:

[
  {
    "alliance_id": 500001,
    "description": "Founded on the tenets of patriotism and hard work...",
    "name": "Caldari",
    "race_id": 1
  }
]
@a-tal
Copy link
Contributor

a-tal commented Jun 8, 2017

will take a look at this when I update the swagger-ui

@aquarhead aquarhead added the New label Jun 9, 2017
@a-tal
Copy link
Contributor

a-tal commented Jun 29, 2017

took a look at upstream swagger-ui v3 again today. they need to fix swagger-api/swagger-ui#2884 (ideally in a backwards compatible way) before we can consider updating.

@aquarhead aquarhead added in-backlog Issue has been accepted, but is considered low priority. and removed New labels Aug 29, 2017
@a-tal
Copy link
Contributor

a-tal commented Nov 30, 2017

this is better handled in the v3 ui, which was just made the default

@a-tal a-tal closed this as completed Nov 30, 2017
@a-tal a-tal removed the in-backlog Issue has been accepted, but is considered low priority. label Nov 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants