Unified Sumo API docs with API references page (Redocusaurus)#6597
Open
Unified Sumo API docs with API references page (Redocusaurus)#6597
Conversation
JV0812
requested review from
amee-sumo,
jpipkin1,
kimsauce and
mafsumo
as code owners
Collaborator
Author
|
@kimsauce This works perfectly for me in my local, can you please run the branch from your end and let me know what all modifications can be performed to make it much better. |
kimsauce
reviewed
Apr 28, 2026
Collaborator
kimsauce
left a comment
kimsauce
left a comment
There was a problem hiding this comment.
Left comment here https://sumologic.atlassian.net/browse/DOCS-68?focusedCommentId=866460
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
2 participants
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.
Purpose of this pull request
This pull request is to avoid opening a new tab to open the API references page, instead treat it as our usual docusaurus page. I have used Redocusaurus plugin to work on it. Also, made sure the font size, style, the code block, and code properties are inline with our usual doc styles.
To add on, the only drawback we can face is the delayed time (2-3 seconds more) to load this page (pulled from an YAML file) as it contains about 36k lines to read.
Select the type of change
Ticket (if applicable)
Unify Sumo API Docs and API spec? (redocusaurus)