You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update the API documentation for the recommended sections.
How do you propose to document this?
1. Update the length of token-id, and token-secret:
In the 'What are API Keys?' section, it is noted that there is a discrepancy in the length of the API Keys.
The token-id length is mentioned as 24 characters, but it seems 39 characters long. Similarly, the token-secret length is mentioned as 32 characters, whereas it seems 52 characters in length.
2. Update the typo of the word perform:
The Authorization section contains a typo; perfrom should be corrected to perform. Please find the section here: Authorization Section
3. Update the URL references of messages.proto and lorawan.proto:
The URLs for messages.proto and lorawan.proto are broken, resulting in a 404 Not Found error when accessed. Please update the messages.proto and lorawan.proto with the correct URLs. Ref: LoRa Gateway MQTT
4. Update The Things Stack Community Edition as The Things Stack Sandbox:
In the errors section of the API documentation, we need to update The Things Stack Community Edition with The Things Stack Sandbox. Please find the reference here: Troubleshooting
Can you do this yourself and submit a Pull Request?
We do not have the references for the messages.proto and lorawan.proto. Hence, filed this issue instead of PR.
Summary
We have identified minor improvements in The Things Stack API documentation.
Why do we need this ?
To ensure the API documentation is up to date.
What is already there? What do you see now?
The Things Stack API documentation
What is missing? What do you want to see?
Update the API documentation for the recommended sections.
How do you propose to document this?
1. Update the length of
token-id
, andtoken-secret
:In the 'What are API Keys?' section, it is noted that there is a discrepancy in the length of the API Keys.
The
token-id
length is mentioned as 24 characters, but it seems 39 characters long. Similarly, thetoken-secret
length is mentioned as 32 characters, whereas it seems 52 characters in length.2. Update the typo of the word perform:
The Authorization section contains a typo;
perfrom
should be corrected toperform
. Please find the section here: Authorization Section3. Update the URL references of messages.proto and lorawan.proto:
The URLs for
messages.proto
andlorawan.proto
are broken, resulting in a404 Not Found
error when accessed. Please update the messages.proto and lorawan.proto with the correct URLs. Ref: LoRa Gateway MQTT4. Update The Things Stack Community Edition as The Things Stack Sandbox:
In the errors section of the API documentation, we need to update
The Things Stack Community Edition
withThe Things Stack Sandbox
. Please find the reference here: TroubleshootingCan you do this yourself and submit a Pull Request?
We do not have the references for the
messages.proto
andlorawan.proto
. Hence, filed this issue instead of PR.No, @nejraselimovic
The text was updated successfully, but these errors were encountered: