docs: add api documentation #50
Conversation
WalkthroughThe updates encompass significant modifications to the "Transcript Summarization" API, including changes to the Postman collection, enhancements to API documentation, and adjustments to the summary service's search functionality. Key alterations include revised request structures, expanded test cases, and a refined searchable fields array, reflecting an improved focus on relevant attributes for job summaries. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant API
participant Service
User->>API: Upload Transcript File
API->>Service: Process File Upload
Service-->>API: Return Success Response
API-->>User: Provide Upload Result
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
kshitij-k-osmosys
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
apps/api/docs/api-documentation.md (1)
1-158: Comprehensive and well-structured API documentation.The documentation provides clear and detailed instructions for interacting with the API, enhancing usability and developer experience.
Consider addressing the style issues suggested by LanguageTool and Markdownlint to improve readability and maintain consistency.
Tools
LanguageTool
[style] ~18-~18: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...the original media type of the resource prior to any content encoding applied before tra...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~19-~19: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...es, expressed as MIME types, the client is able to understand | | Connection | keep-alive ...(BE_ABLE_TO)
[uncategorized] ~20-~20: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... be used to set a timeout and a maximum amount of requests | | Authorization | Bearer ...(AMOUNTOF_TO_NUMBEROF)
[style] ~81-~81: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...the original media type of the resource prior to any content encoding applied before tra...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~82-~82: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...es, expressed as MIME types, the client is able to understand | | Connection | keep-alive ...(BE_ABLE_TO)
[uncategorized] ~83-~83: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... be used to set a timeout and a maximum amount of requests | | Authorization | Bearer ...(AMOUNTOF_TO_NUMBEROF)
Markdownlint
32-32: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
47-47: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
121-121: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
133-133: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- apps/api/Transcript Summarization.postman_collection.json (2 hunks)
- apps/api/docs/api-documentation.md (1 hunks)
- apps/api/src/modules/summary/summary.service.ts (1 hunks)
Additional context used
LanguageTool
apps/api/docs/api-documentation.md
[style] ~18-~18: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...the original media type of the resource prior to any content encoding applied before tra...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~19-~19: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...es, expressed as MIME types, the client is able to understand | | Connection | keep-alive ...(BE_ABLE_TO)
[uncategorized] ~20-~20: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... be used to set a timeout and a maximum amount of requests | | Authorization | Bearer ...(AMOUNTOF_TO_NUMBEROF)
[style] ~81-~81: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...the original media type of the resource prior to any content encoding applied before tra...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~82-~82: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...es, expressed as MIME types, the client is able to understand | | Connection | keep-alive ...(BE_ABLE_TO)
[uncategorized] ~83-~83: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... be used to set a timeout and a maximum amount of requests | | Authorization | Bearer ...(AMOUNTOF_TO_NUMBEROF)
Markdownlint
apps/api/docs/api-documentation.md
32-32: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
47-47: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
121-121: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
133-133: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Additional comments not posted (2)
apps/api/src/modules/summary/summary.service.ts (1)
86-86: Approved change in searchable fields.The update to
searchableFieldsis aligned with the new business requirements. Ensure thatinputFileandoutputTextare indexed in the database for optimal search performance.apps/api/Transcript Summarization.postman_collection.json (1)
Line range hint
3-424: Significant improvements to the Postman collection.The updates enhance the clarity and robustness of the API testing framework. Ensure that the new test cases are integrated with the CI/CD pipeline for automated testing.
This reverts commit 9d7776e.
API PR Checklist
Pre-requisites
PR Details
PR details have been updated as per the given format (see below)
feat: add admin login endpoint)Additional Information
ready for reviewshould be added if the PR is ready to be reviewed)Description:
inputFile,createdBy,outputTextRelated changes:
NA
Screenshots:
NA
Query request and response:
NA
Documentation changes:
Update existing postman collection with scripts and description as well as dummy data
Test suite output:
NA
Pending actions:
NA
Additional notes:
NA
Summary by CodeRabbit
New Features
Bug Fixes
Refactor