search

moderneinc / moderne-docs

Moderne SaaS documentation as Gitbook contents
https://docs.moderne.io
2 stars 2 forks source link

Many GraphQL examples are invalid #62

Closed mike-solomon closed 11 months ago

mike-solomon commented 1 year ago

In the Recipe execution and commits with the Moderne API doc many of the GraphQL examples do not work.

For example the retrieve repositories with results gives me the following error: Variables are invalid JSON: Expected double-quoted property name in JSON at position 35..

It looks like many of the query params are also formatted incorrectly (such as missing trailing commas). It also looks like there are extra { in some cases such as in the query params here.

I'm not sure how to fix these and could use some help from the team to ensure this function as expected.

kmccarp commented 12 months ago

The first thing I notice -- JSON (by default) does not allow comments. A lot of these variable definitions have comments in them, which won't work in graphql's JSON.

kmccarp commented 12 months ago

In theory I've fixed all of this and requested a review: https://app.gitbook.com/o/-MEp_3EtccewzekKY8mZ/s/-MhFwm0iG8BFZKPYoFkH/~/changes/379/user-documentation/how-to-guides/recipe-execution-and-commits-with-graphql

mike-solomon commented 11 months ago

Thanks for taking a look at this! I've gone ahead and merged these changes. I'll assume that's good enough for now - so going to close this issue.