Skip to content

Commit 409c5c9

Browse files
committed
Update documents.
1 parent 363b4d4 commit 409c5c9

File tree

4 files changed

+11
-8
lines changed

4 files changed

+11
-8
lines changed

docs/generated/api.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1783,7 +1783,7 @@
17831783
{
17841784
"kind": "PropertySignature",
17851785
"canonicalReference": "@google-cloud/functions-framework!Request_2#executionId:member",
1786-
"docComment": "",
1786+
"docComment": "/**\n * Request-specified execution ID.\n */\n",
17871787
"excerptTokens": [
17881788
{
17891789
"kind": "Content",
@@ -1838,7 +1838,7 @@
18381838
{
18391839
"kind": "PropertySignature",
18401840
"canonicalReference": "@google-cloud/functions-framework!Request_2#spanId:member",
1841-
"docComment": "",
1841+
"docComment": "/**\n * Cloud Trace span ID.\n */\n",
18421842
"excerptTokens": [
18431843
{
18441844
"kind": "Content",
@@ -1865,7 +1865,7 @@
18651865
{
18661866
"kind": "PropertySignature",
18671867
"canonicalReference": "@google-cloud/functions-framework!Request_2#traceId:member",
1868-
"docComment": "",
1868+
"docComment": "/**\n * Cloud Trace trace ID.\n */\n",
18691869
"excerptTokens": [
18701870
{
18711871
"kind": "Content",

docs/generated/api.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,9 @@ export interface LegacyEvent {
115115

116116
// @public (undocumented)
117117
interface Request_2 extends Request_3 {
118-
// (undocumented)
119118
executionId?: string;
120119
rawBody?: Buffer;
121-
// (undocumented)
122120
spanId?: string;
123-
// (undocumented)
124121
traceId?: string;
125122
}
126123
export { Request_2 as Request }

src/async_local_storage.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ export function getCurrentContext(): ExecutionContext | undefined {
4949

5050
export const getCurrentExecutionId = (): string | undefined => {
5151
return getCurrentContext()?.executionId;
52-
};
52+
};

src/functions.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,16 @@ export interface Request extends ExpressRequest {
3333
*/
3434
rawBody?: Buffer;
3535
/**
36-
* Request-specified execution id.
36+
* Request-specified execution ID.
3737
*/
3838
executionId?: string;
39+
/**
40+
* Cloud Trace trace ID.
41+
*/
3942
traceId?: string;
43+
/**
44+
* Cloud Trace span ID.
45+
*/
4046
spanId?: string;
4147
}
4248

0 commit comments

Comments
 (0)