tailcallhq / tailcall

High Performance GraphQL Runtime
https://tailcall.run
Apache License 2.0
1.3k stars 256 forks source link

doc: Add the following docs #3163

Open tusharmath opened 4 hours ago

tusharmath commented 4 hours ago

Add the following documentation to the LinkType


pub enum LinkType {
    #[default]
    /// Points to another Tailcall Configuration file. The imported
    /// configuration will be merged into the importing configuration.
    Config,

    /// Points to a Protobuf file. The imported Protobuf file will be used by
    /// the `@grpc` directive. If your API exposes a reflection endpoint, you
    /// should set the type to `Grpc` instead.
    Protobuf,

    /// Points to a JS file. The imported JS file will be used by the `@js`
    /// directive.
    Script,

    /// Points to a Cert file. The imported Cert file will be used by the server
    /// to serve over HTTPS.
    Cert,

    /// Points to a Key file. The imported Key file will be used by the server
    /// to serve over HTTPS.
    Key,

    /// A trusted document that contains GraphQL operations (queries, mutations)
    /// that can be exposed a REST API using the `@rest` directive.
    Operation,

    /// Points to a Htpasswd file. The imported Htpasswd file will be used by
    /// the server to authenticate users.
    Htpasswd,

    /// Points to a Jwks file. The imported Jwks file will be used by the server
    /// to authenticate users.
    Jwks,

    /// Points to a reflection endpoint. The imported reflection endpoint will
    /// be used by the @grpc directive to resolve data from gRPC services.
    Grpc,
}

Technical Requirements

tusharmath commented 3 hours ago

/bounty $50

algora-pbc[bot] commented 3 hours ago

💎 $50 bounty • Tailcall Inc.

Steps to solve:

  1. Start working: Comment /attempt #3163 with your implementation plan
  2. Submit work: Create a pull request including /claim #3163 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

🙏 Thank you for contributing to tailcallhq/tailcall! 🧐 Checkout our guidelines before you get started. 💵 More about our bounty program.

Attempt Started (GMT+0) Solution
🟢 @shailedrathakur300 Nov 27, 2024, 6:42:23 PM WIP
🟢 @Dhanus3133 #3165
🟢 @Yash-sudo-web #3169
algora-pbc[bot] commented 2 hours ago

💡 @Yash-sudo-web submitted a pull request that claims the bounty. You can visit your bounty board to reward.