这是indexloc提供的服务,不要输入任何密码
Skip to content

GraphService documentation #1126

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

Merged
merged 5 commits into from
Jan 21, 2025
Merged

GraphService documentation #1126

merged 5 commits into from
Jan 21, 2025

Conversation

nozzlegear
Copy link
Owner

@nozzlegear nozzlegear commented Jan 7, 2025

This pull request adds documentation for using ShopifySharp's recently-updated GraphService.

TODO:

  • Document how to enable intellisense in Rider, VS Code and Visual Studio using the editor config and schema files in this PR.
  • Document how to create a product using the GraphService.
  • Document how to update a product.
  • Document how to add new product options to an existing product.
  • Document how to remove product options from an existing product.
  • Document how to list all existing products on the store.
  • Document how to search for a product by name, sku or vendor.
  • Update readme noting that devs creating new apps must use the GraphService.
    • Also note that devs with existing apps already published on the app store can still use the REST services, but should begin their migration to the GraphService if they haven't already.
  • Update readme with notes for future plans to improve the GraphService and working with the Graph API (Fluent API, generated clients via second ShopifySharp package or CLI tool).

This PR also includes a new test project called ShopifySharp.Tests.Integration, which is intended for any test that makes live calls to Shopify's API. Eventually I want to move all integration tests over to this new project, and keep all non-integration tests (i.e. unit tests) in their current projects.

@saffrondo
Copy link

@nozzlegear Thank you for putting this documentation together. We are in the process of switching over to using GraphQL for our calls but I wanted to note that Shopify has alerted us that we need everything upgraded by 2/1 or it will take our app off the store. I just wanted to pass along the message since your comments seem like there isn't an immediate impact for existing apps, but that's not the message I'm receiving. Please excuse me if I misinterpreted anything. Here is the text from the email:

What happens if I don't update my apps? If your apps continue to use unsupported APIs on or after February 1, Shopify will delist them from the Shopify App Store and block installation of your apps.

@nozzlegear
Copy link
Owner Author

Hey @saffrondo, thanks for the heads up. I don't think you're misinterpreting that email at all. I haven't received one like that for my own apps published on the app store, so I'll reach out to Shopify and see what they're saying; I certainly don't want to give anyone the wrong impression.

Either way, I'm going to merge this documentation in tomorrow, Jan 14. I have it mostly complete, just need to finish it up and push it to Github. I'll publish a new version of ShopifySharp at the same time and you can get started migrating to GraphQL asap.

@nozzlegear
Copy link
Owner Author

I think this is done. The commits for the documentation aren't shown in this PR because GitHub wikis have their own git repositories. I just need to update the docs submodule and release ShopifySharp 6.23.0 in the morning.

@nozzlegear nozzlegear force-pushed the graphservice-documentation branch from 652b387 to 81f9580 Compare January 21, 2025 01:12
…hQL product queries/mutations

Plan is to eventually move all integration tests (i.e. tests that make live calls to Shopify's API) into this project, and keep all unit tests in the other test projects.
Documentation will be added explaining how users can use these files to add intellisense to their editors. Plan is to keep the schema file up-to-date with ShopifySharp's currently-targeted Shopify API version.
@nozzlegear nozzlegear force-pushed the graphservice-documentation branch from 81f9580 to e5fd798 Compare January 21, 2025 07:04
@nozzlegear nozzlegear merged commit c9f8cab into master Jan 21, 2025
@nozzlegear nozzlegear deleted the graphservice-documentation branch January 21, 2025 07:05
@nozzlegear
Copy link
Owner Author

Documentation is updated! Here's the link to the wiki page on using the updated Graphservice: https://github.com/nozzlegear/shopifysharp/wiki/graphql

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Documentation: write a guide on how to use ShopifySharp with the GraphQL API
2 participants