feat: Add Swagger UI to playground #1979
Merged
Conversation
This file contains 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
nasdf
changed the title
Codecov ReportAll modified lines are covered by tests ✅
@@ Coverage Diff @@
## develop #1979 +/- ##
===========================================
+ Coverage 74.76% 74.78% +0.01%
===========================================
Files 246 246
Lines 24298 24298
===========================================
+ Hits 18166 18169 +3
+ Misses 4918 4916 -2
+ Partials 1214 1213 -1
Flags with carried forward coverage won't be shown. Click here to find out more. see 1 file with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
| display: flex; | ||
| flex-direction: column; | ||
| gap: 16px; | ||
| .swagger-ui .opblock .opblock-summary { |
There was a problem hiding this comment.
question: Is any of this css hand crafted, or is it some default stuff copy-pasted from somewhere?
There was a problem hiding this comment.
I went through and manually updated the styles for dark mode. They don't have css variable support in Swagger UI so this was the next best option.
AndrewSisley
approved these changes
Oct 18, 2023
fredcarle
approved these changes
Oct 18, 2023
shahzadlone
pushed a commit
to shahzadlone/defradb
that referenced
this pull request
Feb 23, 2024
## Relevant issue(s) Resolves sourcenetwork#1978 ## Description This PR updates the playground with a [Swagger UI](https://swagger.io/tools/swagger-ui/) tab that allows users to view and interact with the DefraDB API. The UI is auto generated from the OpenAPI specification served from the `/openapi.json` endpoint. <img width="1608" alt="Screenshot 2023-10-17 at 11 02 12 AM" src="https://github.com/sourcenetwork/defradb/assets/1862560/54f9d6c4-82ef-4580-b021-d0e3e36d7534"> ## Tasks - [x] I made sure the code is well commented, particularly hard-to-understand areas. - [x] I made sure the repository-held documentation is changed accordingly. - [x] I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in [tools/configs/chglog/config.yml](tools/configs/chglog/config.yml)). - [x] I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ... ## How has this been tested? Manually Specify the platform(s) on which this was tested: - MacOS
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Relevant issue(s)
Resolves #1978
Description
This PR updates the playground with a Swagger UI tab that allows users to view and interact with the DefraDB API. The UI is auto generated from the OpenAPI specification served from the
/openapi.jsonendpoint.Tasks
How has this been tested?
Manually
Specify the platform(s) on which this was tested: