Adding users in the documentation #3238
Conversation
Signed-off-by: NishantSinghhhhh <nishantsingh_230137@aitpune.edu.in>
WalkthroughThe changes update the developer documentation and extend GraphQL API definitions. The documentation file now features an improved table header and expanded sample database credentials, listing 12 entries for both Administrator and Regular user accounts. Separately, the GraphQL module has been enhanced with three new operations—a query for retrieving tag details, a mutation for creating a tag, and a query for fetching organization information. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant GraphQL_API as GraphQL API
participant DB as Database
Client->>GraphQL_API: Query tag(input: QueryTagInput!)
GraphQL_API->>DB: Retrieve tag details
DB-->>GraphQL_API: Tag data (id, name, organization)
GraphQL_API-->>Client: Return tag response
Client->>GraphQL_API: Mutation CreateTag(input: MutationCreateTagInput!)
GraphQL_API->>DB: Create new tag
DB-->>GraphQL_API: New tag info (id, name, createdAt, organization)
GraphQL_API-->>Client: Return CreateTag response
Client->>GraphQL_API: Query Organization(input: QueryOrganizationInput!, first: Int!)
GraphQL_API->>DB: Fetch organization details
DB-->>GraphQL_API: Organization data (id, name, members)
GraphQL_API-->>Client: Return Organization response
Suggested labels
Suggested reviewers
✨ Finishing Touches
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3238 +/- ##
=================================================
Coverage 45.48% 45.48%
=================================================
Files 455 455
Lines 33935 33935
Branches 757 757
=================================================
Hits 15435 15435
Misses 18496 18496
Partials 4 4 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/docs/docs/developer-resources/testing.md(1 hunks)test/routes/graphql/gql.tada-cache.d.ts(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/docs/docs/developer-resources/testing.md
19-19: Bare URL used
null
(MD034, no-bare-urls)
20-20: Bare URL used
null
(MD034, no-bare-urls)
21-21: Bare URL used
null
(MD034, no-bare-urls)
22-22: Bare URL used
null
(MD034, no-bare-urls)
23-23: Bare URL used
null
(MD034, no-bare-urls)
24-24: Bare URL used
null
(MD034, no-bare-urls)
25-25: Bare URL used
null
(MD034, no-bare-urls)
26-26: Bare URL used
null
(MD034, no-bare-urls)
27-27: Bare URL used
null
(MD034, no-bare-urls)
28-28: Bare URL used
null
(MD034, no-bare-urls)
29-29: Bare URL used
null
(MD034, no-bare-urls)
30-30: Bare URL used
null
(MD034, no-bare-urls)
31-31: Bare URL used
null
(MD034, no-bare-urls)
32-32: Bare URL used
null
(MD034, no-bare-urls)
33-33: Bare URL used
null
(MD034, no-bare-urls)
34-34: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Run tests for talawa api
- GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (1)
test/routes/graphql/gql.tada-cache.d.ts (1)
47-52: Well-structured GraphQL type definitions!The new GraphQL operations are well-defined with proper input types and return fields:
tagquery for retrieving tag detailsCreateTagmutation for creating new tagsOrganizationquery with paginated members list
|
@palisadoes , Sir Do tell me what changes do I need to do in the documentation , for making this PR merge , I have tested all the users They are present in the postgres database and I am able to log In with them |
|
Are any of the regular users members of organizations? If so, please add that information. |
|
Okay will make these changes and commit the changes |
|
@palisadoes , I have checked each regular user , none of them is a part of any organisation |
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
|
@palisadoes Sir , done |
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
palisadoes
merged commit 84562a3
into
PalisadoesFoundation:develop-postgres
What kind of change does this PR introduce?
Feature
Issue Number: : #3225
Snapshots/Videos:
Screencast.from.2025-02-18.00-42-31.webm
I have added the users in this table ,
If relevant, did you update the documentation?
Yes, I have added the new users to the documentation.
Summary
This PR adds 15 new users (administrators and regular users) to the documentation, ensuring that they are properly recorded and referenced.
Does this PR introduce a breaking change?
No
Checklist
CodeRabbit AI Review
Test Coverage
Other information
This update ensures that all user roles and credentials are well documented for reference.
Have you read the contributing guide?
Yes
Summary by CodeRabbit
Documentation
New Features