docs: Update running-the-api.md #193

veh3546 · 2024-04-25T13:41:50Z

User description

Description

API correction

Fixes #186

Dependencies

Future Improvements

Mentions

@rajdip-b

Screenshots of relevant screens

Developer's checklist

My PR follows the style guidelines of this project
I have performed a self-check on my work

If changes are made in the code:

I have followed the coding guidelines
My changes in code generate no new warnings
My changes are breaking another fix/feature of the project
I have added test cases to show that my feature works
I have added relevant screenshots in my PR
There are no UI/UX issues

Documentation Update

This PR requires an update to the documentation at docs.keyshade.xyz
I have made the necessary updates to the documentation, or no documentation changes are required.

Type

documentation

Description

Updated test descriptions to reflect the shift from integration tests to e2e tests.
Modified the command for running unit tests to pnpm run unit:api.
Streamlined the process for running e2e tests, eliminating the need for Docker setup and teardown commands.

Changes walkthrough

Relevant files

Documentation

running-the-api.md `Update Test Descriptions and Commands in Documentation` docs/contributing-to-keyshade/running-things-locally/running-the-api.md Updated the types of tests from "unit and integration tests" to "unit and e2e tests". Changed the command to run unit tests from `pnpm run test:api` to `pnpm` `run unit:api`. Simplified the process to run e2e tests by removing Docker commands and directly using `pnpm run e2e:api`.	+3/-5

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

codiumai-pr-agent-free · 2024-04-25T13:42:16Z

PR Description updated to latest commit (be6ff3b)

codiumai-pr-agent-free · 2024-04-25T13:42:27Z

PR Review

⏱️ Estimated effort to review [1-5]	1, because the changes are straightforward and limited to documentation updates. The modifications involve text changes and command updates in a markdown file, which are easy to review.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

✨ Review tool usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

codiumai-pr-agent-free · 2024-04-25T13:43:00Z

PR Code Suggestions

Category	Suggestions
Enhancement	Add explanatory text or documentation link about the types of tests. Consider adding a brief explanation or a link to documentation about the difference between "unit tests" and "e2e tests" since the terminology has changed from "integration tests" to "e2e tests". This will help new contributors understand the testing strategy more clearly. docs/contributing-to-keyshade/running-things-locally/running-the-api.md [29] -We currently perform two kinds of tests: unit tests and e2e tests. +We currently perform two kinds of tests: unit tests and e2e tests. Unit tests focus on individual components, while e2e tests cover end-to-end scenarios. [Learn more about our testing practices here](link-to-testing-docs).
Enhancement	Add a note about prerequisites for running e2e tests. Since the setup for e2e tests might require additional steps such as setting up a test database, consider adding a note or a section that outlines these prerequisites clearly, especially since the previous version mentioned commands for managing a test database. docs/contributing-to-keyshade/running-things-locally/running-the-api.md [37] -After this is complete, you can run end-to-end tests to validate your entire application from start to finish. Use this command: +After this is complete, you can run end-to-end tests to validate your entire application from start to finish. Ensure that your test environment is properly set up, including any necessary databases. Use this command:

✨ Improve tool usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

rajdip-b

You missed the last one:

Lastly, we want to add another section, that includes both unit and e2e tests. We want to let the users know that they can skip the first two commands and run this directly, as this will perform the unit and e2e tests.

docs/contributing-to-keyshade/running-things-locally/running-the-api.md

sonarcloud · 2024-04-26T20:57:56Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

rajdip-b · 2024-04-27T02:50:10Z

Thanks for your contribution @veh3546!! Feel free to pick any issue that you want.

## [1.3.0](v1.2.0...v1.3.0) (2024-05-12) ### 🚀 Features * Add approval support ([#158](#158)) ([e09ae60](e09ae60)) * **api:** Add configuration live update support ([#181](#181)) ([f7d6684](f7d6684)) * **api:** Add feature to export data of a workspace ([#152](#152)) ([46833aa](46833aa)) * **api:** Add Integration support ([#203](#203)) ([f1ae87e](f1ae87e)) * **api:** Add note to [secure] and variable ([#151](#151)) ([2e62351](2e62351)) * **api:** Add OAuth redirection and polished authentication ([#212](#212)) ([d2968bc](d2968bc)) * **api:** Add support for storing and managing variables ([#149](#149)) ([963a8ae](963a8ae)) * **api:** Added GitLab OAuth ([#188](#188)) ([4d3bbe4](4d3bbe4)) * **api:** Added validation for reason field ([#190](#190)) ([90b8ff2](90b8ff2)) * **api:** Create default workspace on user's creation ([#182](#182)) ([3dc0c4c](3dc0c4c)) * **api:** Reading `port` Dynamically ([#170](#170)) ([fd46e3e](fd46e3e)) * **auth:** Add Google OAuth ([#156](#156)) ([cf387ea](cf387ea)) * **web:** Added waitlist ([#168](#168)) ([1084c77](1084c77)) * **web:** Landing revamp ([#165](#165)) ([0bc723b](0bc723b)) ### 🐛 Bug Fixes * **web:** alignment issue in “Collaboration made easy” section ([#178](#178)) ([df5ca75](df5ca75)) * **workspace:** delete duplicate tailwind config ([99d922a](99d922a)) ### 📚 Documentation * add contributor list ([f37569a](f37569a)) * Add integration docs ([#204](#204)) ([406ddb7](406ddb7)) * Added integration docs to gitbook summary ([ab37530](ab37530)) * **api:** Add swagger docs of API key controller ([#167](#167)) ([2910476](2910476)) * **api:** Add swagger docs of User Controller ([#166](#166)) ([fd59522](fd59522)) * fix typo in environment-variables.md ([#163](#163)) ([48294c9](48294c9)) * Remove supabase from docs ([#169](#169)) ([eddbce8](eddbce8)) * **setup:** replace NX with Turbo in setup instructions ([#175](#175)) ([af8a460](af8a460)) * Update README.md ([b59f16b](b59f16b)) * Update running-the-api.md ([177dbbf](177dbbf)) * Update running-the-api.md ([#193](#193)) ([3d5bcac](3d5bcac)) ### 🔧 Miscellaneous Chores * Added lockfile ([60a3b9b](60a3b9b)) * Added lockfile ([6bb512c](6bb512c)) * **api:** Added type inference and runtime validation to `process.env` ([#200](#200)) ([249e07d](249e07d)) * **api:** Fixed prisma script env errors ([#209](#209)) ([8762354](8762354)) * **API:** Refactor authority check functions in API ([#189](#189)) ([e9d710d](e9d710d)) * **api:** Refactor user e2e tests ([b38d45a](b38d45a)) * **ci:** Disabled api stage release ([97877c4](97877c4)) * **ci:** Update stage deployment config ([868a6a1](868a6a1)) * **codecov:** update api-e2e project coverage ([1e90d7e](1e90d7e)) * **dockerfile:** Fixed web dockerfile ([6134bb2](6134bb2)) * **docker:** Optimized web Dockerfile to reduct image size ([#173](#173)) ([444286a](444286a)) * **release:** Downgraded package version ([c173fee](c173fee)) * **release:** Fix failing release ([#213](#213)) ([40f64f3](40f64f3)) * **release:** Install pnpm ([1081bea](1081bea)) * **release:** Updated release commit ([b8958e7](b8958e7)) * **release:** Updated release commit ([e270eb8](e270eb8)) * Update deprecated husky Install command ([#202](#202)) ([e61102c](e61102c)) * Upgrade @million/lint from 0.0.66 to 0.0.73 ([#172](#172)) ([dd43ed9](dd43ed9)) * **web:** Updated fly memory config ([4debc66](4debc66)) ### 🔨 Code Refactoring * **api:** Made events central to workspace ([#159](#159)) ([9bc00ae](9bc00ae)) * **api:** Migrated to cookie based authentication ([#206](#206)) ([ad6911f](ad6911f)) * **monorepo:** Migrate from nx to turbo ([#153](#153)) ([88b4b00](88b4b00))

rajdip-b · 2024-05-12T17:14:57Z

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Update running-the-api.md

be6ff3b

codiumai-pr-agent-free bot added the type: documentation Improvements or additions to documentation label Apr 25, 2024

codiumai-pr-agent-free bot added the Review effort [1-5]: 1 label Apr 25, 2024

veh3546 mentioned this pull request Apr 25, 2024

Fix incorrect docs about testing the API #186

Closed

rajdip-b changed the title ~~Update running-the-api.md~~ docs: Update running-the-api.md Apr 25, 2024

rajdip-b requested changes Apr 25, 2024

View reviewed changes

docs/contributing-to-keyshade/running-things-locally/running-the-api.md Outdated Show resolved Hide resolved

Update running-the-api.md

c2963f3

rajdip-b requested changes Apr 25, 2024

View reviewed changes

docs/contributing-to-keyshade/running-things-locally/running-the-api.md Outdated Show resolved Hide resolved

Update running-the-api.md

23afdf0

veh3546 requested a review from rajdip-b April 25, 2024 23:51

Update running-the-api.md

73a2403

rajdip-b approved these changes Apr 27, 2024

View reviewed changes

rajdip-b merged commit 3d5bcac into keyshade-xyz:develop Apr 27, 2024
6 checks passed

kriptonian1 pushed a commit that referenced this pull request May 5, 2024

docs: Update running-the-api.md (#193)

784c918

rajdip-b added the released label May 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update running-the-api.md #193

docs: Update running-the-api.md #193

veh3546 commented Apr 25, 2024 •

edited by rajdip-b

Loading

codiumai-pr-agent-free bot commented Apr 25, 2024

codiumai-pr-agent-free bot commented Apr 25, 2024

codiumai-pr-agent-free bot commented Apr 25, 2024

rajdip-b left a comment

sonarcloud bot commented Apr 26, 2024

rajdip-b commented Apr 27, 2024

rajdip-b commented May 12, 2024

docs: Update running-the-api.md #193

docs: Update running-the-api.md #193

Conversation

veh3546 commented Apr 25, 2024 • edited by rajdip-b Loading

User description

Description

Dependencies

Future Improvements

Mentions

Screenshots of relevant screens

Developer's checklist

Documentation Update

Type

Description

Changes walkthrough

codiumai-pr-agent-free bot commented Apr 25, 2024

codiumai-pr-agent-free bot commented Apr 25, 2024

PR Review

codiumai-pr-agent-free bot commented Apr 25, 2024

PR Code Suggestions

rajdip-b left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Apr 26, 2024

Quality Gate passed

rajdip-b commented Apr 27, 2024

rajdip-b commented May 12, 2024

veh3546 commented Apr 25, 2024 •

edited by rajdip-b

Loading