Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Commit

Permalink
Unified API Disclaimer (#1193)
Browse files Browse the repository at this point in the history
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 <anton.pirker@sentry.io>
Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com>
  • Loading branch information
3 people committed Mar 15, 2024
1 parent 71fd88c commit 77dcd4d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/docs/sdk/unified-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
title: 'Unified API'
---

<Alert title="Note" level="info">

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, <Link to="/sdk/hub_and_scope_refactoring/">Hub & Scope Refactoring</Link>

</Alert>

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.

Expand Down

0 comments on commit 77dcd4d

Please sign in to comment.