Wrong interruptions link for the tasks resource

Hello, when queued task with /api/tasks/task-id/details?verbose=false the Task.Links['Interruptions'] element is "/api/tasks". Thanks!

Hi Dmitry,

Thanks for getting in touch!

That does indeed look like a bug. Hope it hasn’t impacted you too much. I’ve created an issue and we’ll aim to get a fix out in the next release.

Hope that helps!

Regards,
Matt

Hi Matt, thanks! No, it hasn’t affected us at all. We don’t tend to use links in resources. Somehow, we’re more used to a plain-old-make-your-URI approach :slight_smile: I’ve just found this bug while studying API responses. Speaking of which…

there is another problem. The API is poorly documented at some places. I mean, while the API documentation is OK at the top level, but it’s not enough if you really need to do things with the API, like creating releases or deploying, or even creating projects from internal templates (what we do). The API documentation misses a lot of details, and we need to query our server and study responses. At some places we use Chrome’s dev console and study requests which are sent from Octopus UI to Octopus Server.

Hi Dmitry,

With regard to the plain-old-make-your-own-URI approach - we do not consider changing links a breaking change, as the intention is that consumers follow a RESTful approach and follow the links to get the data you are looking for, so you may end up with breaking changes if you are building your own links.

As per the API documentation, we know its not great. It is primarily designed to support the UI, but the usage by our customers has grown substantially. On our roadmap for the next 12 months, we are intending to support swagger which will give a much more discoverable and usable API.

Hope that helps!

Regards,
Matt