search

SDFIdk / WEBPROJ

REST API exposing coordinate transformations with PROJ
MIT License
8 stars 6 forks source link

Update docs to v 1.1 at docs.dataforsyningen.dk #41

Closed kbevers closed 2 years ago

kbevers commented 2 years ago

From https://docs.dataforsyningen.dk/#webproj

image

Should be version 1.1.0 now.

larsnaesbye commented 2 years ago

Info here : https://github.com/SDFIdk/SwaggerUI-docker/issues/1

larsnaesbye commented 2 years ago

The current swagger.json doesn't validate because some operations do not have unique IDs (the 1.0 operations and 1.1 operations are identical). This makes it harder to autoconvert to OpenAPI 3.

larsnaesbye commented 2 years ago

It might be worth a while to switch to apispec instead, which can generate both version 2 (Swagger) and 3 (OpenAPI).

kbevers commented 2 years ago

It might be worth a while to switch to apispec instead, which can generate both version 2 (Swagger) and 3 (OpenAPI).

How does that integrate with flask_restx?

larsnaesbye commented 2 years ago

I don't think it does.

larsnaesbye commented 2 years ago

The only other options I see are 1) to continue to expose Swagger 2.0, but fix the inconsistencies and still manually convert and tweak at every release 2) to improve flask_restx

kbevers commented 2 years ago

I suppose 2 is the better option. Do you mind spending an hour or two on estimating how much work is involved in doing that? If it can be done in a reasonable amount of time I think it is worth the effort.

larsnaesbye commented 2 years ago

Last release and commit 10 months ago. I think it’s the sure way of getting voted in as maintainer….

kbevers commented 2 years ago

Or it is what is needed to reinvigorate the project. The alternative is to completely rewrite WEBPROJ to accomodate a different model for documentation. Choose your medicine :-)

larsnaesbye commented 2 years ago

The way I understand it, rewriting flask_restx to support both Swagger 2.0 and OpenAPI 3.0 is also a major effort. But I can look into it, if it is a thing GRF wants done.

larsnaesbye commented 2 years ago

To fix the current problem right here and now, I can generate the faulty Swagger 2.0 descriptor, alter the duplicates, convert it using Mermade and make a PR to docs.

larsnaesbye commented 2 years ago

Pulled. Now awaiting deployment into production.

kbevers commented 2 years ago

Cool. It would be nice to have the procedure described in a HOWTORELEASE file. Do you mind doing that?

larsnaesbye commented 2 years ago

I'll look into it.

Also, closing this because the new version has been deployed.