apinf / platform

Apinf - Open source API management platform with multi proxy and protocol support
https://apinf.com/
European Union Public License 1.1
74 stars 33 forks source link

[PRODUCTION] Displaying of Swagger file doesn't work properly in some cases #2791

Closed marla-singer closed 7 years ago

marla-singer commented 7 years ago

Steps

  1. go to page https://apinf.io/apis/openapi-space
  2. navigate to Documentation tab

Found

Expected

Environment: APInf production site, v0.47.0 Google Chrome

Guesses & Goals

bajiat commented 7 years ago

@brylie Try to reproduce at least in development.

marla-singer commented 7 years ago

@bajiat I'm afraid it would happen because of early incorrect migration step and now it is not so easy to reproduce. @brylie I think it could be reproduced if you would change develop to 0.43 version or 0.44, upload a swagger file or enter the link to the doc after that change the branch to the current release version.

bajiat commented 7 years ago

@marla-singer Can you check with @shaliko if we need to clean up incorrect data manually?

marla-singer commented 7 years ago

@bajiat It is not a solution because this incorrect data are generated in our code

bajiat commented 7 years ago

@marla-singer Can you check whether this has affected production?

marla-singer commented 7 years ago

@bajiat It has affected to User Usability joxi_screenshot_1505723197054

brylie commented 7 years ago

What is the extent of the problem? How many APIs are affected? How likely is this to occur in other deployments?

marla-singer commented 7 years ago

How many APIs are affected?

I don't know how many APIs but this problem have been repeated 55 times during 2 months https://sentry.samposoftware.com/sentry/apinf-production/issues/30/

brylie commented 7 years ago

OK, it looks like it is happening a few times a day over the past couple of months. I am just wondering about the effect size of this bug. How might we assess how many APIs are affected?

marla-singer commented 7 years ago

@brylie I see as navigate through each API in catalog and check it by hand :thinking:

How might we assess how many APIs are affected?

bajiat commented 7 years ago

@brylie @marla-singer @matleppa Any volunteers to go through the APIs manually?

matleppa commented 7 years ago

Apinf.io

Swagger documentation and status (2017-09-19):

Result

24 APIs with a functioning swagger document 1 API with a swagger document failing to load 2 APIs, which possibly have a swagger document (timeglass just going on and on and on and on...)

matleppa commented 7 years ago

Apinf.io

Swagger documentation and status (2017-09-20) (0.50.0):

APInf catalog REST API (OK) APInf Catalog REST API (fail) fails to open API APInf Management REST API (OK) Customer Management API (OK) Digitraffic Road metadata (Failed to load spec.) GitHub (OK) Laivadata - API (fail) fails to open API Linked events (Turku) (OK) Makeup API (OK) MPASSid Register API (fail) API fails to open

OMDB API (fail) fails to open API OpenAPI space (documentation does not open, perhaps swagger) OpenAPI-webconverter (documentation does not open, perhaps swagger) OpenWeatherMap (fail) fails to open API

Opintopolku Oppijanumerorekisteri (OK) Petstore API (OK) Product Catalog Management API (OK) Product Inventory Management API (OK) Salaxy Open API (OK) Simple DX Poll REST API (OK) Suomi.fi -palvelutietovaranto REST API (OK) The NYT Article search (OK) The NYT Books (OK) TripGo (OK) Trouble Ticket API (OK) Turku Issue reporting API (OK) Turku Street Maintenance API (OK) Ylläs Events API (fail) API fails to open.

Ylläs transit routes as GTFS (OK)

Result

20 APIs with a loading swagger document 1 API with a swagger document failing to load 2 APIs, which possibly have a swagger document (timeglass just going on and on and on and on...) 6 APIs fail to open

Each operation causes lots of error log writings.