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

feat: add swagger documentation #8

Merged
merged 7 commits into from
Jun 11, 2024
Merged

feat: add swagger documentation #8

merged 7 commits into from
Jun 11, 2024

Conversation

kieranroneill
Copy link
Member

Description

  • Refactor routes to use versioning
  • Add script to parse swago documents
  • Update swagger.json file on release
  • Add v1/swagger function to parse swagger.json

Type of change

  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🏗️ Build configuration (CI configuration, scaffolding etc.)
  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 📝 Documentation update(s)
  • 📦 Dependency update(s)
  • 👩🏽‍💻 Improve developer experience
  • ⚡ Improve performance
  • ✨ New feature (non-breaking change which adds functionality)
  • ♻ Refactor
  • ⏪ Revert changes
  • 🧪 New tests or updates to existing tests

@kieranroneill kieranroneill added ♻️ refactor The refactoring fairy has waved their magic wand ✨ feature New feature or request 📦 dependencies New dependencies labels Jun 11, 2024
@kieranroneill kieranroneill self-assigned this Jun 11, 2024
@kieranroneill kieranroneill linked an issue Jun 11, 2024 that may be closed by this pull request
Add Swagger documentation #7
Closed
@kieranroneill kieranroneill merged commit 6f34fd7 into beta Jun 11, 2024
1 check passed
@kieranroneill kieranroneill deleted the 7-add-swagger-documentation branch June 11, 2024 13:06
github-actions bot pushed a commit that referenced this pull request Jun 11, 2024
@agoralabs-bot
chore(release): 1.1.0-beta.1
799c90a 
# [1.1.0-beta.1](v1.0.0...v1.1.0-beta.1) (2024-06-11)

### Features

* add swagger documentation ([#8](#8)) ([6f34fd7](6f34fd7))
@agoralabs-bot
Copy link
Contributor

🎉 This PR is included in version 1.1.0-beta.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@agoralabs-bot agoralabs-bot added the 🚀 released To the moon! label Jun 11, 2024
github-actions bot pushed a commit that referenced this pull request Jun 11, 2024
@agoralabs-bot
chore(release): 1.1.0
b98f4bc 
# [1.1.0](v1.0.0...v1.1.0) (2024-06-11)

### Features

* add swagger documentation ([#8](#8)) ([6f34fd7](6f34fd7))
@agoralabs-bot
Copy link
Contributor

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@kieranroneill kieranroneill

Labels
📦 dependencies New dependencies ✨ feature New feature or request ♻️ refactor The refactoring fairy has waved their magic wand 🚀 released To the moon!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Swagger documentation
2 participants
@kieranroneill @agoralabs-bot