Skip to content

Missing documentation #4209

Closed
Closed

Description

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    ⌛ staleNothing happened with this issue in quite a while🌶️ hot chocolate📚 documentationThis issue is about working on our documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions