PalisadoesFoundation / talawa-docs

Documentation for Talawa and Talawa-API
https://docs.talawa.io/
GNU General Public License v3.0
44 stars 146 forks source link

Add policy page on Talawa-API GraphQL resolver design #568

Closed palisadoes closed 11 months ago

palisadoes commented 1 year ago

Is your feature request related to a problem? Please describe. We need to add a page under the Talawa-API developers section on how we design our GraphQL resolvers. The conversation here needs to be converted into a Talawa-API policy.

Describe the solution you'd like See above

Describe alternatives you've considered

None

Approach to be followed (optional) See above

Additional context N/A

Potential internship candidates Please read this if you are planning to apply for a Palisadoes Foundation internship https://github.com/PalisadoesFoundation/talawa/issues/359

palisadoes commented 1 year ago

@EshaanAgg @xoldyckk Please take a look

EshaanAgg commented 1 year ago

@palisadoes The linked discussion is quiet specific to only cursor based pagination resolvers.

As I see it, we can create a general page highlighting some common design principles, and in it we can add a specific section about the cursor pagination.

I can start working on it as soon as #1187 is merged in Talawa API, taking it as a basis for good practices.

palisadoes commented 1 year ago

I created a design guide page that we can use as a starting point.

kb-0311 commented 1 year ago

@palisadoes @EshaanAgg is correct that the discussion is specific to how we model the API for connections, not the complete industry-standard graphql design practices.

I had mentioned in my GSoC proposal how we would be going about making sure that graphql API in talawa-api is up to production standards by making sure the API design follows all practices here ->

https://graphql.org/learn/best-practices/

@EshaanAgg would you like to pass this issue to me? I will create a general standard API design doc then you can take care of documenting the connections resolvers part. That would be a lot better as I already have code snippets ready about this the how we can get rid of the antipattern nature of graphql in talawa-api

EshaanAgg commented 1 year ago

Sure @kb-0311. You can tag me once the general document is ready, and I'll then complete the pagination part.

Unassigning myself. @palisadoes please assign @kb-0311 for now.

github-actions[bot] commented 1 year ago

This issue did not get any activity in the past 10 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

palisadoes commented 1 year ago

Any updates on this?

kb-0311 commented 1 year ago

@palisadoes yeah working on the error policy currently as soon as it has been done and merged will complete this one too.

github-actions[bot] commented 1 year ago

This issue did not get any activity in the past 10 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

github-actions[bot] commented 11 months ago

This issue did not get any activity in the past 180 days and thus has been closed. Please check if the newest release or develop branch has it fixed. Please, create a new issue if the issue is not fixed.