Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

docs: add link to api docs #3405

Merged
merged 1 commit into from
Jan 19, 2024
Merged

docs: add link to api docs #3405

merged 1 commit into from
Jan 19, 2024

Conversation

inventvenkat
Copy link
Contributor

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

Add Api Documentation link to the README.md

Additional Changes

  • This PR modifies the API contract
  • This PR modifies the database schema
  • This PR modifies application configuration/environment variables

Motivation and Context

Making Api docs accessible to the users.

How did you test it?

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed the submitted code
  • I added unit tests for my changes where possible
  • I added a CHANGELOG entry if applicable

@inventvenkat inventvenkat added the C-doc Category: Documentation updates label Jan 19, 2024
@inventvenkat inventvenkat self-assigned this Jan 19, 2024
@inventvenkat inventvenkat requested a review from a team as a code owner January 19, 2024 10:52
@inventvenkat inventvenkat linked an issue Jan 19, 2024 that may be closed by this pull request
Add API doc in README.md for easy access #3407
Closed
@SanchithHegde SanchithHegde added this pull request to the merge queue Jan 19, 2024
Merged via the queue into main with commit 4e1e78e Jan 19, 2024
10 checks passed
@SanchithHegde SanchithHegde deleted the docs/apidocs branch January 19, 2024 14:16
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@Narayanbhat166 Narayanbhat166 Narayanbhat166 approved these changes

@SanchithHegde SanchithHegde SanchithHegde approved these changes

Assignees

@inventvenkat inventvenkat

Labels
C-doc Category: Documentation updates
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add API doc in README.md for easy access
4 participants
@inventvenkat @SanchithHegde @Narayanbhat166 @venkatesh-juspay