Provided a description for the /channels/:channel/socket endpoint.
Pre-filled 'application/json' as the default content type for some endpoints.
Removed the "required" flag for entries that are not really required in /activities/:channel and others.
Added examples for some POST requests
Set a "deprecated" flag for /overlays/:channel/action/:action as that endpoint doesn't work. Added a description on how to obtain the expected result using /v3/overlays/:channel/action
This work is in progress with the aim of enhancing the clarity of SE API documentation for all users. The plan is to continually review each endpoint to make it more informative. The objectives include:
Documenting previously undocumented endpoints.
Including examples in all entries to enhance understanding.
Pre-filling default parameters, such as 'Accept: application/json'.
In this pull request:
/overlays/:channel/endpoint./channels/:channel/socketendpoint./activities/:channeland others./overlays/:channel/action/:actionas that endpoint doesn't work. Added a description on how to obtain the expected result using/v3/overlays/:channel/actionThis work is in progress with the aim of enhancing the clarity of SE API documentation for all users. The plan is to continually review each endpoint to make it more informative. The objectives include: