From 77dcd4d9ecc01bd61e83f290ae7a55113e1f2aa3 Mon Sep 17 00:00:00 2001 From: Steven Eubank <47563310+smeubank@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:14:55 +0100 Subject: [PATCH] Unified API Disclaimer (#1193) With the work on hubs and scopes refactoring, this page needs a disclaimer even more than before https://develop.sentry.dev/sdk/hub_and_scope_refactoring/ --------- Co-authored-by: Anton Pirker Co-authored-by: Alexander Dinauer --- src/docs/sdk/unified-api/index.mdx | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/docs/sdk/unified-api/index.mdx b/src/docs/sdk/unified-api/index.mdx index b73ad2daca..9d7450c4e8 100644 --- a/src/docs/sdk/unified-api/index.mdx +++ b/src/docs/sdk/unified-api/index.mdx @@ -2,6 +2,20 @@ title: 'Unified API' --- + + +Everything written here sounds real nice. However, we live in a practical world, and expect each platform to adhere to what makese sense for the developers there. What is written below is not to be taken as strict rules. It is a guide and to be thought of as a tool to help developers build SDKs which work well which eachother. + +The top priority when building SDKs is a high quality API and developer experience, don’t let unified API be an excuse to build things which don't make sense for a given language. + +*Types Example:* Typed languages might have very different developer experience than dynamic. + +*Platform Example:* Does Rust have exceptions? Nope, don't name APIs for rust like `captureException`. + +*Unified API Example:* We don't like Hubs and Scopes anymore, and we are redefining that, Hub & Scope Refactoring + + + New Sentry SDKs should follow the unified API, use consistent terms to refer to concepts. This documentation explains what the unified API is and why it exists.