teco-project / teco-core Goto Github PK

Pagination helpers that return a response sometimes include an empty one at the end. This is because when Teco cannot determine if there're more results, a new request will always be sent.

However, such behavior may be unexpected for some developers because such "failed query" may contain false or pseudo information. We should explain this behavior in documentation and guide users to handle such case properly.

We actually have two different standard of percent-encoded query:

• x-www-form-urlencoded: for POST request body;
• RFC 3986 for GET request URL.

TCSignerV1 (and COSSigner) needs to handle the differences properly and, if possible, parse the format exactly and throw error on malformed input.

As a side-effect, TCSignerV1 should also precondition on the provided HTTP method.

URLComponents conforms to RFC 3986, which is used by Tencent Cloud API standard; while URL conforms to the older RFC 1808. To ensure the URL is correctly encoded, we should change the internal from using URL to URLComponents or its fragments. This is potentially breaking because some non-throwing APIs will become throwing. We'll investigate a proper solution in v0.6.

TecoCore is the core framework of Teco, and documentation is an important part of a library.

The documentation bundle of TecoCore should at least include:

• An article explaining how TecoCore works;
• A guide for building a custom service;
• A guide for configuring TCClient;
• A guide for configuring TCServiceConfig;
• A guide for using pre-defined and custom CredentialProvider;
• A guide on error handling;
• A guide for using custom region and EndpointProvider.

We may refer to https://github.com/soto-project/soto-core

We should have a stable pagination API surface by 1.0.0 release, including related protocols, functions and data structures.