Events API Method signature issue

Chris_Blyth · 15 February 2017 10:47

Hi,

I am using the events api and have come across an issue with 2 ambiguous methods:

Method: https://github.com/OctopusDeploy/OctopusClients/blob/16f9dba7645b49604520597fc61ef2348cf9f1f2/source/Octopus.Client/Repositories/Async/EventRepository.cs#L38

and

github.com

OctopusDeploy/OctopusClients/blob/16f9dba7645b49604520597fc61ef2348cf9f1f2/source/Octopus.Client/Repositories/Async/EventRepository.cs#L52


{
    return Client.List<EventResource>(Client.RootDocument.Link("Events"), new
    {
        skip,
        user = filterByUserId,
        regarding = regardingDocumentId,
        @internal = includeInternalEvents.ToString()
    });
}


public Task<ResourceCollection<EventResource>> List(int skip = 0,
    string from = null,
    string to = null,
    string regarding = null,
    string regardingAny = null,
    bool includeInternalEvents = true,
    string user = null,
    string users = null,
    string projects = null,
    string environments = null,
    string eventGroups = null,

Are both called “List” but have different signatures with all optional parameters.
Therefore in order to decide which to use, you HAVE to provide enough optional parameters to make it use the correct version.
It’s also confusing for a consumer who is then unsure as to which is the one they need.

Shane_Gill · 16 February 2017 02:11

Hi Chris,

Thanks for the feedback.

I agree, those methods are very ambiguous. The one with the shorter signature was kept for backwards compatibility but, as you pointed out, unless you provide all parameters it won’t necessarily be invoked.

I’ve created an issue to remove the deprecated method: https://github.com/OctopusDeploy/Issues/issues/3180

Cheers,
Shane