Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support full API in playground #1978

Closed
nasdf opened this issue Oct 18, 2023 · 0 comments · Fixed by #1979
Closed

Support full API in playground #1978

nasdf opened this issue Oct 18, 2023 · 0 comments · Fixed by #1979
Assignees
@nasdf
Labels
feature New feature or request
Milestone
DefraDB v0.8

Comments

@nasdf
Copy link
Member

nasdf commented Oct 18, 2023

The playground should allow users to view and interact with the entire DefraDB API.
@nasdf nasdf added the feature New feature or request label Oct 18, 2023
@nasdf nasdf self-assigned this Oct 18, 2023
@nasdf nasdf mentioned this issue Oct 18, 2023
Merged
4 tasks
nasdf added a commit that referenced this issue Oct 18, 2023
@nasdf
feat: Add Swagger UI to playground (#1979)
9cfd33f 
## Relevant issue(s)

Resolves #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
@fredcarle fredcarle added this to the DefraDB v0.8 milestone Nov 6, 2023
shahzadlone pushed a commit to shahzadlone/defradb that referenced this issue Feb 23, 2024
@nasdf
feat: Add Swagger UI to playground (sourcenetwork#1979)
ddcbc2c 
## 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
Assignees

@nasdf nasdf

Labels
feature New feature or request
Projects
None yet
Milestone
DefraDB v0.8
Development

Successfully merging a pull request may close this issue.

feat: Add Swagger UI to playground nasdf/defradb
2 participants
@nasdf @fredcarle