OAI / OpenAPI-Specification

The OpenAPI Specification Repository
https://openapis.org
Apache License 2.0
29k stars 9.07k forks source link

We should not keep a minified version of respec.js #3845

Closed Bellangelo closed 3 months ago

Bellangelo commented 5 months ago

Problem

There are 2 minified versions of respec.js for 3.x and for 4.x versions. These files exists in the gh-pages:

  1. /js/respec-oai.js
  2. /js/respec-arrazzo.js

These files are basically unmaintainable and should instead try to store a human-readable version of it.

Proposed solution

There is a respec-oai.build.js.map which might help us decouple the minified version respec-oai.js. After we succeed in decoupling the file and keep only the source code in our repo, we need to add a build step in our deploy process so we can push the minified version again.

Alternative Proposal

Do not use a modified fork of ReSpec, instead use the unmodified original, see #3944.

ralfhandl commented 5 months ago

In addition we should update to the latest version of ReSpec and have a documented process to refresh our snapshot.

Which also means we should not "fork" or otherwise modify the original ReSpec, and use the same snapshot for OpenAPI and Arazzo.

ralfhandl commented 4 months ago

Differences between OAI snapshots of ReSpec 21.0.1 and the original: