chore(core): Mark Span.getSpanJSON method as internal (getsentry#10197)

Lms24 · web-flow · commit 6077cb9b7df2 · 2024-01-16T12:58:03.000Z
Clarify the API status of the `Span.getSpanJSON` method. This method is purely purposed for internal usage and users should not rely on it but instead on `spanToJSON`. ref getsentry#10184
diff --git a/packages/core/src/tracing/span.ts b/packages/core/src/tracing/span.ts
@@ -508,6 +508,11 @@ export class Span implements SpanInterface {
 
   /**
    * Get JSON representation of this span.
+   *
+   * @hidden
+   * @internal This method is purely for internal purposes and should not be used outside
+   * of SDK code. If you need to get a JSON representation of a span,
+   * use `spanToJSON(span)` instead.
    */
   public getSpanJSON(): SpanJSON {
     return dropUndefinedKeys({
