search

CGSmith-LLC / shipwise-api

Shipwise API
Other
0 stars 0 forks source link

Build should validate Swagger JSON [FEATURE] #149

Open cgsmith opened 1 year ago

cgsmith commented 1 year ago

Buddy.works handles the build process. It should also verify the Swagger documentation is valid according to the spec.

cebe commented 1 year ago

As I wrote in https://github.com/CGSmith-LLC/shipwise-api/issues/146#issuecomment-1438557847 I don't see what exactly we want to validate when the docs are generated from PHPDoc. This makes more sense when API spec is written as JSON or YAML file.

cgsmith commented 1 year ago

I noted this down as an issue because when I was testing different doc generators the OpenAPI spec v2 was complaining about the generated swagger.json not adhering to the spec.

cebe commented 1 year ago

Okay, so the build job should write down the spec file and then check it. It needs to run the yii app to do this though.