Improve the API fields data type information in the API documentation

[ymgupta]

Summary

The Things Stack users are often confused with API field data types i.e., in the documentation API field type type: bytes does not imply base64. Also, the type of API field interpreted should depends on the actual message. For example, the frm_payload of the ApplicationDownlink is read as a base64 type, whereas the dev_eui field of the EndDeviceIdentifiers is read as hex.

Why do we need this ?

To help users in distinguishing between different data types of API fields.

What is already there? What do you see now?

https://www.thethingsindustries.com/docs/reference/api/

What is missing? What do you want to see?

API fields with more details on the data types/examples.
@adriansmares , could you please add your insights here?

How do you propose to document this?

...

Can you do this yourself and submit a Pull Request?

No, @nejraselimovic

[adriansmares]

We need to update our tooling in order to deal with this inconsistency. I will pick this up.

[KrishnaIyer]

@adriansmares: It would be great if you could find some time to pick this up this month.

[KrishnaIyer]

I'll pick this up as part of the API documentation item that I'm working on.

[nejraselimovic]

hey @KrishnaIyer was this covered in #1230?

[KrishnaIyer]

I think this requires a few small updates to the generated docs. I'll pick this up later this month.