Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Missing documentation #4209

Closed
45 tasks
tobias-tengler opened this issue Sep 8, 2021 · 5 comments
Closed
45 tasks

Missing documentation #4209

tobias-tengler opened this issue Sep 8, 2021 · 5 comments
Labels
📚 documentation This issue is about working on our documentation. 🌶️ hot chocolate ⌛ stale Nothing happened with this issue in quite a while
Milestone

Comments

@tobias-tengler
Copy link
Collaborator

tobias-tengler commented Sep 8, 2021

The following is a list of features / functionality that still needs to be documented in Hot Chocolate.

Missing

  • Resolver compiler
  • Scoped/Local State
  • Multiple schemas
  • Type Module
  • Type interceptors
  • Error handling
  • Request options
  • Schema options
  • Optional / DefaultValue
  • Queryplan / Execution strategies (serial vs. parallel)
  • Conventions
    (for naming conventions, cross-link to note added in this PR about use with xml docs)
  • Resolver Types (pure vs async)
  • Schema-first APIs
  • Coding approaches (pros & cons / some examples)
  • Subscription authentication (currently only a workaround exists)
  • Testing
  • DataLoaderOptions
  • UnsafeCreate
  • Introspection Extensions
  • Directive Introspection
  • Validation rules
  • Deployment (AZF & AWS Lambda)
  • Subscription cleanup / switching between apollo / graphql-ws
  • Apollo Federation SubGraph
  • Client controlled nullability
  • Oneof
  • Stream / Defer
  • Batching

Improvements

  • Describe possible solutions for input polymorphism
  • Data extension methods like .Sort(context)
  • Api Reference > ASP.NET Core => Server
  • More details about Unions and input object types
  • Add interface and enum type extensions
  • Showcase query complexity with Redis
  • Note about AddQueryType with only type extensions
  • (Optional) Application Insights Integration

Need to be reviewed

  • DataLoader
  • Filtering
  • Sorting
  • MongoDB
  • Neo4J
  • Spatial
  • Automatic persisted queries
  • Operation complexity
  • Distributed schemas (after v13)

This list is not exhaustive, feel free to edit the task list with missing pieces.

@tobias-tengler tobias-tengler added 📚 documentation This issue is about working on our documentation. 🌶️ hot chocolate labels Sep 8, 2021
@michaelstaib
Copy link
Member

Dynamic Schemas

  • Type Modules -> Added support for type modules.
  • UnsafeCreate
  • TypeInterceptors

@michaelstaib
Copy link
Member

Query Plan

  • Resolver Types (pure vs async)
  • Control behavior or plan serial/parallel

@michaelstaib
Copy link
Member

  • Resolver Compiler

@michaelstaib
Copy link
Member

  • Introspection Authorization
  • Introspection Extensions
  • Directive Introspection

@stale
Copy link

stale bot commented May 16, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the ⌛ stale Nothing happened with this issue in quite a while label May 16, 2022
@ChilliCream ChilliCream locked and limited conversation to collaborators May 16, 2022
@PascalSenn PascalSenn converted this issue into discussion #5073 May 16, 2022

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
📚 documentation This issue is about working on our documentation. 🌶️ hot chocolate ⌛ stale Nothing happened with this issue in quite a while
Projects
None yet
Development

No branches or pull requests

2 participants