feat: update graphql guideliness #99
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the GraphQL guidelines for the frontend by renaming and refactoring the API service for project status reports while also updating related GraphQL definitions and examples.
- Renamed and refactored the API service from DataSourceConfluenceApi to ProjectStatusReportApi with new methods for querying, deleting, and subscribing to project status reports.
- Updated GraphQL definitions, including a new query, mutation, and subscription, along with enhanced documentation examples and notes.
Comments suppressed due to low confidence (1)
docs/Frontend_tutorials/standards/FE-Standards-graphql.md:223
- [nitpick] The note about using the tagged template literal syntax appears to be repeated (see also line 223). Consider consolidating these duplicate notes into a single, clear instruction to reduce redundancy.
> Note: When defining GraphQL with the gql tag, use the tagged template literal syntax without enclosing it in parentheses <code>gql\`...\`;</code>. Do not write <code>gql(\`...\`);</code> instead, use it directly followed by a template literal as shown in the examples below. Using parentheses will cause a parsing error—such as Uncaught (in promise) GraphQLError: Syntax Error: Unexpected "["—because it interferes with the proper tag processing of the template literal. For further details on tagged template syntax, please see the MDN documentation on tagged templates.
added 2 commits
June 30, 2025 14:51
docs: update GraphQL standards for dynamic queries This update enhances the documentation on using GraphQL with directives and dynamic query construction. It clarifies how to conditionally include fields based on plugin activity and emphasizes the need for proper syntax when utilizing the gql tag.
Updated the naming examples for GraphQL queries and fragments. The example now references `projectStatusReport.ts` and `fullProjectStatusReport.ts` to provide clarity on naming conventions within the documentation. This ensures consistency with current project standards.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added docs for subscriptions. Define rules for dynamically construct graphql definitions with plugins and add expample of using graphql directives