Are there any plans to use string literals for des...

# graphql-kotlin

[Goregius]

Are there any plans to use string literals for descriptions instead of comment descriptions since comment descriptions don't get picked up by Apollo Gateway by default?

[Dariusz Kuc]

we are using Apollo Gateway and comments seems to be working fine?

[Dariusz Kuc]

afaik single line comments can be made as # your comment

[Dariusz Kuc]

multi line comments should be done in """ block """

[Dariusz Kuc]

we probably should add support for multi line comments

[Dariusz Kuc]

At the same time we are just using graphql java underneath it (atm)

[Dariusz Kuc]

So it should technically just works

[Goregius]

Maybe it's a new update to Apollo that doesn't allow them anymore because I do remember it working before. But even with the latest example spring federated server it's not showing. Could just be my laptop being weird

[Goregius]

[Goregius]

[Dariusz Kuc]

interesting

[Dariusz Kuc]

wondering whether this is something with federation logic in the gateway

[Dariusz Kuc]

we are currently using stitching in our apollo server and documentation works fine

[Goregius]

Yeah it's just Apollo (not just the gateway) that removes the # descriptions from the schema, I tried this with a normal Apollo server. I'm assuming this is because it treats them as purely comments and not as descriptions.

[Goregius]

type Product @key(fields: "upc") {
  upc: String!
  #name from hash comment
  name: String
  """price from string literal"""
  price: Int
  weight: Int
}

[Goregius]

the name didn't have a description but the price did

[Goregius]

Actually I think it's apollo federation, not specifically the gateway, the comments are shown when using a non federated service

[Goregius]

I did some digging and found that graphql-java have made this change (found in this commit: https://github.com/graphql-java/graphql-java/commit/0919e71c1d04b982426f651821c6ee52437b5b84) which changes the format of descriptions to the new quote format. This change has been released but not as a major release. And is modifiable with the descriptionsAsHashComments function.

[Dariusz Kuc]

👍 once gql java releases new version we'll upgrade our dependency

[Dariusz Kuc]

Wondering if federated gateway strips out all comments

[Dariusz Kuc]

Regardless whether they start with # or """

[Dariusz Kuc]

This would simplify their stitching logic between federated types

[Dariusz Kuc]

Feel free to raise this as an issue on the graphql kotlin repo so we can keep track of it

[Goregius]

the gateways only strip the # comments, the """ comments stay there, I'm guessing they do this because federation was created after # became depreciated

[Dariusz Kuc]

👍 thanks for raising this