Merged
Conversation
dmsg-discovery: Added endpoint list and example JSON responses dmsg-server: Added endpoint documentation JSON examples are colorized using tidwall/pretty.
0pcom
force-pushed
the
add-endpoint-examples
branch
from
dcf80b2 to
11a73a2
Compare
The ANSI reset codes (\033[0m) and newlines (\n\r) in flag descriptions were causing issues with Cobra help menu rendering, disrupting color output and formatting. These codes have been removed from all flag descriptions across the codebase.
This reverts commit 5a8ed71.
Updates skywire to include color functions in the custom help template for usage=false mode, enabling colored output in dmsg CLI help.
Includes examples for:
- GET /health
- GET /dmsg-discovery/entry/{pk} (client and server entries)
- POST /dmsg-discovery/entry/ (new and update responses)
- DEL /dmsg-discovery/entry
- GET /dmsg-discovery/entries
- GET /dmsg-discovery/visorEntries
- GET /dmsg-discovery/available_servers
- GET /dmsg-discovery/all_servers
- GET /dmsg-discovery/servers/clients
- GET /dmsg-discovery/server/{pk}/clients
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
dmsg-discovery: Added endpoint list and example JSON responses
dmsg-server: Added endpoint documentation