Return GraphQL responses with underscore keys #1310
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brucebolt
force-pushed
the
underscore-graphql-keys
branch
2 times, most recently
from
4effb1a to
4f202c7
Compare
Publishing API returns GraphQL responses with camel cased keys. However we use underscored keys in our applications. Therefore transforming the keys here, so the same does not need to be duplicated in every consuming application. Note: the activesupport gem is required, as `deep_transform_keys` (on Hash) and `underscore` (on String) are both part of Rails, not Ruby. This avoids needing to rewrite those methods in this application.
brucebolt
force-pushed
the
underscore-graphql-keys
branch
from
4f202c7 to
33b96b6
Compare
mike3985
reviewed
Dec 17, 2024
| @@ -15,6 +15,7 @@ Gem::Specification.new do |s| | |||
| s.required_ruby_version = ">= 3.1" | |||
| s.files = Dir.glob("lib/**/*") + Dir.glob("test/fixtures/**/*") + %w[README.md Rakefile] | |||
| s.require_path = "lib" | |||
| s.add_dependency "activesupport" | |||
There was a problem hiding this comment.
Are there any users of this gem that don't already have ActiveSupport?
I do get that it's still a bit gross to do this even if that's currently the case, but if it's not the case I'd be a lot less keen on doing this 😆
Maybe there are standalone gems that implement these methods?
mike3985
reviewed
Dec 17, 2024
| def graphql_query(query) | ||
| post_json("#{endpoint}/graphql", query:) | ||
| response = post_json("#{endpoint}/graphql", query:) |
There was a problem hiding this comment.
Repeating what I said in directly to Bruce, for the rest of the team: I reckon we could do something with the JsonClient's create_response block (
gds-api-adapters/lib/gds_api/json_client.rb
Lines 93 to 94 in 0ddad8b
|
Closing in favour of using snake cased keys for fields and arguments in Publishing API: alphagov/publishing-api#3049. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Publishing API returns GraphQL responses with camel cased keys. However we use underscored keys in our applications.
Therefore transforming the keys here, so the same does not need to be duplicated in every consuming application.
Trello card