[Feature] Can we enable uploading workout JSON?

[arpanghosh8453]

I have seen a commented instance of this.

python-garminconnect/garminconnect/__init__.py

Lines 1458 to 1464 in 159750b

	# def upload_workout(self, workout_json: str):
	# """Upload workout using json data."""
	# url = f"{self.garmin_workouts}/workout"
	# logger.debug("Uploading workout using %s", url)
	# return self.garth.post("connectapi", url, json=workout_json, api=True)

But I am not sure why it's commented out and not implemented in the code. Is there any obvious problem with this feature?

Thank you.

[psdupvi]

Take a look at the last few comments of this issue:

#185

Basically, it seems the JSON needs to perfectly match the expected structure -- no wiggle room for missing fields, etc. So I think that's commented out to avoid the number of questions about why it's not working that this repo would get if we put it back in.

You should be able to uncomment it and use the correctly structured JSON -- but that changes from sport to sport and isn't documented anywhere that I'm aware of.

Perhaps we should put a comment above that explaining why it's commented out.

[jbpaux]

I guess if you export a workout as json and import it back it will work.
Or maybe if we provide some example json workouts it can avoid questions.

[cyberjunky]

If we know the requirements for valid json format we can check them using something like the pydantic package.

[cyberjunky]

I have enabled it in the API and implemented an example workout upload in demo.py. Can you try latest version?

[friedrichwilken]

How about implementing data types specific for exercise types?

Something like:

class CyclingWorkout(BaseModel):
    ...

Might look like overkill, but if the API is so strict, this could be the way. Also, there is no need to implement them all at once.