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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Friendly names for scalars in GraphQL schema #231

Merged
merged 7 commits into from
Aug 22, 2022

Conversation

cafca
Copy link
Member

@cafca cafca commented Aug 11, 2022

Removes Scalar suffix in gql schema.

Closes #229

馃搵 Checklist

  • Add tests that cover your changes
  • Add this PR to the Unreleased section in CHANGELOG.md
  • Link this PR to any issues it closes
  • New files contain a SPDX license header

@cafca
Copy link
Member Author

cafca commented Aug 11, 2022

@adzialocha the other odd one is EntryHash as we just call that Hash everywhere else. We could also rename it for consistency but on the other hand having a type just called "hash" might also be confusing. The type's description tells you what it is but still. What do you think?

@cafca cafca requested a review from adzialocha August 11, 2022 16:41
@codecov
Copy link

codecov bot commented Aug 11, 2022

Codecov Report

Merging #231 (469edf4) into development (9ddee8b) will increase coverage by 0.12%.
The diff coverage is 93.65%.

@@               Coverage Diff               @@
##           development     #231      +/-   ##
===============================================
+ Coverage        94.12%   94.24%   +0.12%     
===============================================
  Files               59       59              
  Lines             4834     4867      +33     
===============================================
+ Hits              4550     4587      +37     
+ Misses             284      280       -4     
Impacted Files Coverage 螖
...quadoggo/src/graphql/client/dynamic_types/tests.rs 100.00% <酶> (酶)
aquadoggo/src/graphql/client/static_query.rs 100.00% <酶> (酶)
aquadoggo/src/graphql/replication/client.rs 85.71% <酶> (酶)
aquadoggo/src/graphql/replication/query.rs 90.37% <酶> (酶)
aquadoggo/src/graphql/replication/response.rs 93.87% <酶> (酶)
...go/src/graphql/scalars/encoded_operation_scalar.rs 84.61% <50.00%> (-7.06%) 猬囷笍
aquadoggo/src/graphql/scalars/entry_hash_scalar.rs 83.33% <81.81%> (+1.51%) 猬嗭笍
...adoggo/src/graphql/scalars/encoded_entry_scalar.rs 91.66% <91.66%> (酶)
aquadoggo/src/graphql/client/dynamic_query.rs 93.42% <100.00%> (酶)
aquadoggo/src/graphql/client/mutation.rs 100.00% <100.00%> (酶)
... and 6 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@adzialocha adzialocha changed the base branch from main to development August 22, 2022 10:38
* development:
  clippy
  Use `DocumentStore` trait from p2panda rs (#249)
  Corrections in e2e test
  Untagged operation format & schema validation (#235)
Copy link
Member

@adzialocha adzialocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adzialocha the other odd one is EntryHash as we just call that Hash everywhere else. We could also rename it for consistency but on the other hand having a type just called "hash" might also be confusing. The type's description tells you what it is but still. What do you think?

I agree, let's stick to EntryHash. Its also the only "Hash" we provide right now via the API.

@adzialocha adzialocha merged commit d63f6c4 into development Aug 22, 2022
@adzialocha adzialocha deleted the gql-scalar-names branch August 22, 2022 11:42
adzialocha added a commit that referenced this pull request Aug 22, 2022
* development:
  Friendly names for scalars in GraphQL schema (#231)
  clippy
  Use `DocumentStore` trait from p2panda rs (#249)
  Corrections in e2e test
  Untagged operation format & schema validation (#235)
adzialocha added a commit that referenced this pull request Aug 22, 2022
* development:
  Fix GraphQL responses (#236)
  Friendly names for scalars in GraphQL schema (#231)
  clippy
  Use `DocumentStore` trait from p2panda rs (#249)
  Corrections in e2e test
  Untagged operation format & schema validation (#235)
adzialocha added a commit that referenced this pull request Aug 22, 2022
* development:
  Rename `nextEntryArgs` and `publishEntry` (#232)
  Fix GraphQL responses (#236)
  Friendly names for scalars in GraphQL schema (#231)
  clippy
  Use `DocumentStore` trait from p2panda rs (#249)
  Corrections in e2e test
  Untagged operation format & schema validation (#235)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GraphQL Docs look funny with Scalar suffixes
2 participants