Create a functionality to add a log message and a label in one API call

This was requested in gwcelery!1515 (merged)

Hi @leo-singer,

Do you think this functionality can be easily implemented and worth implementing as it reduces number of API calls?

I tried to look at the labels section of the code and was thinking does something like this address this?

class SupereventLabels(BaseLabels):

    path = 'labels/'

    def create(self, label):
        return super().create_or_update(None, data={'name': label})
    
    def create_with_log(self, label, log_message):
        return super().create_or_update(None, data={'name': label,
                                                    'comment': log_message})

I am not super familiar with django rest framework. Please let me know your thoughts.

I am not super familiar with django rest framework.

What does the Django REST framework have to do with this?

Do you think this functionality can be easily implemented and worth implementing as it reduces number of API calls?

Sure. Would you care to open a MR?

In the interest of time, could you please write an MR for this @leo-singer? We're planning for the next gwcelery release to include SSM, so having this functionality in gracedb-sdk would be very helpful. I believe you could write an MR in very little time, which should be weighed against the much longer amount of time that a non-gracedb-sdk maintainer would take.

Alternatively, I still have an MR somewhere to go back to the stock gracedb API, which has all of the functionality that we want.

Did you try this? It looks like it already works:

client.superevents['MS220721n'].logs.create(comment='foo bar bat', label='HIGH_PROFILE')

!8 (merged) adds the documentation and tests for this, but you can use this functionality right away.

wherever gracedb_sdk makes the POST to write a log message, there just needs to be an optional keyword argument label: [str] like here, which will apply the label to the parent object (event/superevent) after writing the log.

mentioned in commit 4593250f

mentioned in merge request !8 (merged)

mentioned in commit ff3cebba

mentioned in commit 9924dd04

closed with merge request !8 (merged)

closed with commit 9924dd04

Fixed by !8 (merged); no release necessary as the only changes were to unit tests and documentation.

mentioned in merge request gwcelery!1515 (merged)