SwiftPackageIndex-Server icon indicating copy to clipboard operation
SwiftPackageIndex-Server copied to clipboard

Move to OpenAPI spec as API source of truth

Open finestructure opened this issue 2 years ago • 1 comments

We've uncovered some issues with generating the OpenAPI spec from VaporToOpenAPI annotations. We're also blocked from bumping this dependency to the next major release due to a compile error.

Finally, Honza makes some great points why starting from the OpenAPI spec as the source of truth is good best practise.

We should take a stab at switching to this approach.

finestructure avatar Dec 01 '23 09:12 finestructure

I guess I shouldn't continue to babble away on a closed issue, huh? ;-)

As a related note, the VaporToOpenAPI issue might be resolved with a version update to 4.4.3 per https://github.com/dankinsoid/VaporToOpenAPI/issues/17 (although it might also require an update to an example declaration - uncertain there, but I'll try and look)

heckj avatar Dec 01 '23 17:12 heckj

One of the main reasons to tackle this, the VaporToOpenAPI compile issue, has been fixed. Since we don't have a huge suite of API endpoints (and they're not changing much) this isn't the most pressing of tasks, nor is it a good first issue, so I'm going to close it for now.

finestructure avatar Jul 17 '24 08:07 finestructure