server: add a couple doc comments (#22213)

## Description

Missed adding some doc comments in #22109
This commit is contained in:
Zach Newton 2024-08-14 15:58:28 -07:00 коммит произвёл GitHub
Родитель 18b76b29ff
Коммит 38194426d6
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
2 изменённых файлов: 6 добавлений и 3 удалений

Просмотреть файл

@ -63,7 +63,7 @@ export function convertSummaryTreeToWholeSummaryTree(parentHandle: string | unde
// @internal
export function convertWholeFlatSummaryToSnapshotTreeAndBlobs(flatSummary: IWholeFlatSummary, treePrefixToRemove?: string): INormalizedWholeSummary;
// @internal (undocumented)
// @internal
export const CorrelationIdHeaderName = "x-correlation-id";
// @internal
@ -78,7 +78,7 @@ export const defaultHash = "00000000";
// @internal
export const DocDeleteScopeType = "doc:delete";
// @internal (undocumented)
// @internal
export const DriverVersionHeaderName = "x-driver-version";
// @internal (undocumented)
@ -647,7 +647,7 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
writeSummaryTree(summaryTree: ISummaryTree_2, parentHandle: string, summaryType: IWholeSummaryPayloadType, sequenceNumber?: number, initial?: boolean): Promise<string>;
}
// @internal (undocumented)
// @internal
export const TelemetryContextHeaderName = "x-telemetry-context";
// @internal

Просмотреть файл

@ -4,14 +4,17 @@
*/
/**
* HTTP Header name for a request/action's Correlation Id to trace an action across services.
* @internal
*/
export const CorrelationIdHeaderName = "x-correlation-id";
/**
* HTTP Header name for the client's Driver Version to be sent to the service for telemetry purposes.
* @internal
*/
export const DriverVersionHeaderName = "x-driver-version";
/**
* HTTP Header name for Telemetry Context data being passed from service to service.
* @internal
*/
export const TelemetryContextHeaderName = "x-telemetry-context";