Working with large OpenAPI files

[jaredmoody]

Hi @notEthan!

I'm evaluating using scorpio for a work project and got stuck pretty early. The OpenAPI JSON document I'm wanting to consume is quite large - 6.6MB of JSON 😳 - and just trying to load this class hangs indefinitely.

module ConnectWise
  class Resource < Scorpio::ResourceBase
    self.openapi_document = JSON.load(Rails.root.join('docs/connect_wise.json'))
  end
end

I assume Scorpio is trying to generate a lot of code at once when that's loaded.

Do you have general recommendations here? I only need a small subset of the API that the document defines - should I delete everything from the OpenAPI document I'm not using? Is there something I could do differently to lazy-load/generate only what I need?

Thanks!

[notEthan]

Unfortunately, the poor performance of Scorpio (really JSI, but effectively both) on large documents is one of the two big hurdles I'm working through before declaring these libraries as v1.0 production-ready things. I have a rough prototype working that fixes this and makes performance many orders of magnitude better. But at the moment it is only a prototype and needs a good bit more work before being generally usable. It's getting there, but I am not so good at estimating the time it will take to be ready for release.