docs: add api test cases

[kshitij-k-osmosys]

API PR Checklist

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary unit testing.
• I have updated the required api docs as applicable.
• I have added/updated test cases to the test suite as applicable

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Query request and response examples have been added (as applicable, in case added or updated)
• Documentation changes have been listed (as applicable)
• Test suite output is added (as applicable)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:

• Add api-test-cases documentation
• Add steps to test using newman
• Add steps to test using postman

Related changes:

NA

Screenshots:

NA

Query request and response:

NA

Documentation changes:

• Create api-test-cases.md
• Add supporting images in assets folder

Test suite output:

NA

Pending actions:

NA

Additional notes:

NA

Summary by CodeRabbit

• New Features

  • Introduced a comprehensive API Test Cases Documentation section outlining prerequisites and step-by-step instructions for running API test cases.
  • Added methods for executing test cases using Postman and Newman, including commands and guidance for viewing results.

• Documentation

  • Enhanced usability of API testing by providing structured instructions previously absent.

[coderabbitai]

Walkthrough

The change introduces a comprehensive section in the API Test Cases Documentation, detailing the prerequisites, setup instructions, and methods for executing API test cases using Postman and Newman. It provides a step-by-step guide for users to clone the repository, install necessary tools, and view results from the test executions.

Changes

Files	Change Summary
apps/api/docs/api-test-cases.md	Added a comprehensive section outlining prerequisites, step-by-step guide, and execution methods for API test cases using Postman and Newman.

Poem

In the meadow, hops a bright-eyed hare,
With tests and guides, we make a pair.
Postman and Newman, side by side,
Together we leap, with knowledge as our guide.
So gather your tools, let’s take a chance,
For every test case, we’ll joyfully dance! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

apps/api/docs/api-test-cases.md (1)

44-44: Minor grammatical correction needed.

Consider adding the article "the" before "top right" to improve the sentence clarity.

Here's the suggested change:

- Select the environment on top right.
+ Select the environment on the top right.

Tools

LanguageTool

[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...llection 3. Select the environment on top right. 4. ClickRun Transcript Summari...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f48676 and c8a2012.

Files ignored due to path filters (3)

• apps/api/docs/assets/newman-cli-run-results.png is excluded by !**/*.png
• apps/api/docs/assets/newman-html-report.png is excluded by !**/*.png
• apps/api/docs/assets/postman-api-run-results.png is excluded by !**/*.png

Files selected for processing (1)

• apps/api/docs/api-test-cases.md (1 hunks)

Additional context used

LanguageTool

apps/api/docs/api-test-cases.md

[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...llection 3. Select the environment on top right. 4. ClickRun Transcript Summari...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

Additional comments not posted (1)

apps/api/docs/api-test-cases.md (1)

1-80: Comprehensive and well-structured documentation for API testing.

The document is well-organized and provides clear instructions for setting up and running API tests using both Postman and Newman. The inclusion of direct links, command snippets, and images enhances the usability of the documentation.

Tools

LanguageTool

[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...llection 3. Select the environment on top right. 4. ClickRun Transcript Summari...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)