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

Streamline OpenAPI / HTTP documentation #2677

Closed
shahzadlone opened this issue Jun 4, 2024 · 0 comments · Fixed by #2678
Closed

Streamline OpenAPI / HTTP documentation #2677

shahzadlone opened this issue Jun 4, 2024 · 0 comments · Fixed by #2678
Assignees
@shahzadlone
Labels
documentation Improvements or additions to documentation

Comments

@shahzadlone
Copy link
Member

Streamline OpenAPi / HTTP documentation and ensure its always up to date.
@shahzadlone shahzadlone added the documentation Improvements or additions to documentation label Jun 4, 2024
@shahzadlone shahzadlone self-assigned this Jun 4, 2024
@shahzadlone shahzadlone changed the title Streamline OpenAPi / HTTP documentation Streamline OpenAPI / HTTP documentation Jun 4, 2024
@shahzadlone shahzadlone mentioned this issue Jun 4, 2024
Merged
shahzadlone added a commit that referenced this issue Jun 4, 2024
@shahzadlone
docs: Add http/openapi documentation & ci workflow (#2678)
7dc07e7 
## Relevant issue(s)
Related #510 
Resolve #2677

## Description
- Detect OpenAPI / HTTP documentation is always up to date.
- Generate open-api docs in the appropriate dir.

## How has this been tested?
- using `act` tool
- manually introducing a change and seeing the action fail:
https://github.com/sourcenetwork/defradb/actions/runs/9359749777/job/25763961265?pr=2678

Specify the platform(s) on which this was tested:
- WSL2 instance
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shahzadlone shahzadlone

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Add http/openapi documentation & ci workflow shahzadlone/defradb
1 participant
@shahzadlone