#211 Add back API docs for /api/v1.0/version endpoint
Merged by dcallagh. Opened by lholecek.
lholecek/greenwave fix-docs-version-link  into  master

Download 211.patch

Fixes Sphinx warning (treated as error in CI) for a missing link to the
removed documentation.

Another solution would be to keep the documentation for the endpoint and mention that it's deprecated and /about should be used.

:thumbsup:

But the /api/v1.0/version endpoint was a documented API... Arguably not a very valuable one, and it should probably have been an undocumented endpoint (like /healthcheck) instead, although that ship has sailed. But I don't think we should have removed it.

So I am -1 on this, and also -1 on the patch (already merged) which removed the endpoint... I will post a PR to put it back, as a redirect to the new preferred /api/v1.0/about endpoint.

Oh, sorry. I just realised that we didn't actually delete the endpoint. :-) Only the docs for it. So yeah. I think the right solution here is to just put back the docs for /api/v1.0/version (it was a documented API after all) noting that it is deprecated in favour of /api/v1.0/about. And that will fix this release notes build failure too.

rebased onto afb7ccdb45baa9d8d2a3e86e92800ed4c549dc42

I think the right solution here is to just put back the docs for /api/v1.0/version (it was a documented API after all) noting that it is deprecated in favour of /api/v1.0/about.

Done.

The change looks fine. I don't understand the commit message though... there seems to be too many negatives. You are not omitting anything, you are adding something... How about:

add back API docs for /api/v1.0/version endpoint

And can you please also edit the PR title to match (so we don't get confused if we look through old PRs in future).

rebased onto 6dd97060d28c7c54b0367dc2d8a72f8bfe8b49dd

I don't understand the commit message though... there seems to be too many negatives.

@dcallagh, I fixed the clumsy commit message.

(Wow, I used edit button instead of reply and edited your comment. Pagure UI is confusing.)

rebased onto b647ef78ef3185c65644dfa82f2465f45004b5ce

:+1: thanks Lukas!

Going to hit the button on this one now, so that we can get our Jenkins job passing...

Pull-Request has been merged by dcallagh

Metadata