Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add value descriptions to (all) GraphQL enums #4248

Open
NyanKiyoshi opened this issue Jun 10, 2019 · 8 comments
Open

Add value descriptions to (all) GraphQL enums #4248

NyanKiyoshi opened this issue Jun 10, 2019 · 8 comments
Labels
good first issue Good first issues graphql Issues related to the GraphQL API technical debt

Comments

@NyanKiyoshi
Copy link
Member

It also needs to be "standardized" into the Saleor code and into the documention. So we only have one style and the "perfect" non-magic way.

@NyanKiyoshi NyanKiyoshi added the graphql Issues related to the GraphQL API label Jun 10, 2019
@NyanKiyoshi NyanKiyoshi self-assigned this Jun 10, 2019
@maarcingebala
Copy link
Member

Btw we've recently bumped Graphene version and now Graphene supports setting deprecation messages for enums. I think we have our own wrapper for that which I think isn't required anymore. See the changelog and these changes.

@maarcingebala
Copy link
Member

That's a separate issue but this version also added the implementation of Decimal scalar so we should be able to drop our own implementation.

@NyanKiyoshi
Copy link
Member Author

Btw we've recently bumped Graphene version and now Graphene supports setting deprecation messages for enums. I think we have our own wrapper for that which I think isn't required anymore. See the changelog and these changes.

Our wrapper is converting our custom enums that have the CHOICES fiels into a GraphQL enum, it's meant to avoid repetitive [(k, v.upper()) for k, v in cls.CHOICES.items()].

@NyanKiyoshi NyanKiyoshi removed their assignment Jul 4, 2019
@stale
Copy link

stale bot commented Nov 1, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Nov 1, 2019
@stale
Copy link

stale bot commented Jan 4, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 4, 2020
@stale
Copy link

stale bot commented Mar 5, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Mar 5, 2020
@stale stale bot removed the stale label Mar 5, 2020
@peelar peelar removed the backlog label Aug 17, 2022
@maarcingebala maarcingebala added this to the Hackathon milestone Jun 20, 2023
@maarcingebala maarcingebala added the good first issue Good first issues label Jun 27, 2023
@maarcingebala
Copy link
Member

Adding good first issue label. If anyone wants to pick this up, it's best to work on this in smaller batches and provide pull requests for each module separately. Reviewing and improving is easier than a big PR with changes in many modules.

@maarcingebala maarcingebala removed this from the Hackathon milestone Jun 27, 2023
@moraj-turing
Copy link

I am available to work on this, please provide an example, I see some enums already have @proprerty def description() created, is this what the issue is referring to?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good first issues graphql Issues related to the GraphQL API technical debt
Projects
None yet
Development

No branches or pull requests

4 participants