duality-labs / duality

Apache License 2.0
10 stars 5 forks source link

Remove openapi.yml from build #416

Closed teddyknox closed 1 year ago

teddyknox commented 1 year ago

I will be glad to no longer see the line changes of the yml file on every PR 👏

Shouldn't we also delete the actual yml file though?

And I think we can also delete these lines from the Ignite config:

@dib542 do you think it's valid to leave it in, but not to check whether it's always up to date?

dib542 commented 1 year ago

I will be glad to no longer see the line changes of the yml file on every PR 👏 Shouldn't we also delete the actual yml file though?

And I think we can also delete these lines from the Ignite config:

@dib542 do you think it's valid to leave it in, but not to check whether it's always up to date?

If we plan on maintaining it regularly (at least on every release) then maybe we could leave it in the repo and have for example a separate CI task to update it when changes land in main. But if we don't plan to update it I'd rather have it gone. It's really frustrating to develop against an API spec to later find out that its wrong and several versions behind where it should be.

teddyknox commented 1 year ago

I will be glad to no longer see the line changes of the yml file on every PR 👏 Shouldn't we also delete the actual yml file though?

And I think we can also delete these lines from the Ignite config:

@dib542 do you think it's valid to leave it in, but not to check whether it's always up to date?

If we plan on maintaining it regularly (at least on every release) then maybe we could leave it in the repo and have for example a separate CI task to update it when changes land in main. But if we don't plan to update it I'd rather have it gone. It's really frustrating to develop against an API spec to later find out that its wrong and several versions behind where it should be.

If we could easily enforce that the openapi.yml if up to date we would. Since we can't it seems like overkill to stop generating the openapi.yml (and stop generating documentation from it) altogether.

teddyknox commented 1 year ago

Ok, in that case we can remove the openapi.yml from the repo entirely. Updating to that effect.