From 9fd7018e15c44f8e7a23e309c8aff0757f60a103 Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Mon, 26 Oct 2020 12:08:55 -0700 Subject: [PATCH 1/4] Adding required tags to page template. --- docgen/theme/layouts/default.hbs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docgen/theme/layouts/default.hbs b/docgen/theme/layouts/default.hbs index 72111fb4e..17106e8d8 100644 --- a/docgen/theme/layouts/default.hbs +++ b/docgen/theme/layouts/default.hbs @@ -7,6 +7,8 @@ + + {{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}} From 34db981d4c6eec0fc17f07cef05740d927050d6b Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Mon, 26 Oct 2020 14:35:04 -0700 Subject: [PATCH 2/4] Adding formatting and fixing typo discovered in internal review. --- src/function-builder.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/function-builder.ts b/src/function-builder.ts index 919f9f09b..8fc7ce585 100644 --- a/src/function-builder.ts +++ b/src/function-builder.ts @@ -133,15 +133,15 @@ export function region( /** * Configure runtime options for the function. * @param runtimeOptions Object with optional fields: - * 1. memory: amount of memory to allocate to the function, possible values + * 1. `memory`: amount of memory to allocate to the function, possible values * are: '128MB', '256MB', '512MB', '1GB', and '2GB'. - * 2. timeoutSeconds: timeout for the function in seconds, possible values are + * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are * 0 to 540. - * 3. failurePolicy: failure policy of the function, with boolean `true` being + * 3. `failurePolicy`: failure policy of the function, with boolean `true` being * equivalent to providing an empty retry object. - * 4. vpcConnector: id of a VPC connector in same project and region - * 5. vpcConnectorEgressSettings: when a vpcConnector is set, control which - * egress traffic is sent through the vpcConnector. + * 4. `vpcConnector`: id of a VPC connector in the same project and region + * 5. `vpcConnectorEgressSettings`: when a `vpcConnector` is set, control which + * egress traffic is sent through the `vpcConnector`. * * Value must not be null. */ From 67a53d5c046faefbd0a2a4804729d3d791482e7b Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Mon, 26 Oct 2020 15:05:13 -0700 Subject: [PATCH 3/4] More fixes/additions discovered in internal review. --- docgen/content-sources/toc.yaml | 25 ++++++++++++++++++++----- src/function-builder.ts | 15 +++++++++------ 2 files changed, 29 insertions(+), 11 deletions(-) diff --git a/docgen/content-sources/toc.yaml b/docgen/content-sources/toc.yaml index 37093f7c2..722b0f818 100644 --- a/docgen/content-sources/toc.yaml +++ b/docgen/content-sources/toc.yaml @@ -23,6 +23,20 @@ toc: - title: 'config.Config' path: /docs/reference/functions/config_.config.config.html + - title: 'functions.function-configuration' + path: /docs/reference/functions/function_configuration_.html + section: + - title: 'config.DeploymentOptions' + path: /docs/reference/functions/function_configuration_.deploymentoptions.html + - title: 'config.FailurePolicy' + path: /docs/reference/functions/function_configuration_.failurepolicy.html + - title: 'config.RuntimeOptions' + path: /docs/reference/functions/function_configuration_.runtimeoptions.html + - title: 'config.Schedule' + path: /docs/reference/functions/function_configuration_.schedule.html + - title: 'config.ScheduleRetryConfig' + path: /docs/reference/functions/function_configuration_.scheduleretryconfig.html + - title: 'functions.analytics' path: /docs/reference/functions/providers_analytics_.html section: @@ -127,11 +141,6 @@ toc: - title: 'ObjectMetadata' path: /docs/reference/functions/providers_storage_.objectmetadata.html - - title: 'functions.handler' - path: /docs/reference/functions/handler_builder_.html - section: - - title: 'HandlerBuilder' - path: /docs/reference/functions/handler_builder_.handlerbuilder.html - title: 'functions.testLab' path: /docs/reference/functions/providers_testlab_.html section: @@ -143,3 +152,9 @@ toc: path: /docs/reference/functions/providers_testlab_.testmatrix.html - title: 'testLab.testMatrixBuilder' path: /docs/reference/functions/providers_testlab_.testmatrixbuilder.html + + - title: 'functions.handler' + path: /docs/reference/functions/handler_builder_.html + section: + - title: 'HandlerBuilder' + path: /docs/reference/functions/handler_builder_.handlerbuilder.html \ No newline at end of file diff --git a/src/function-builder.ts b/src/function-builder.ts index 8fc7ce585..9b5f5660b 100644 --- a/src/function-builder.ts +++ b/src/function-builder.ts @@ -173,13 +173,16 @@ export class FunctionBuilder { /** * Configure runtime options for the function. - * @param runtimeOptions Object with three optional fields: - * 1. failurePolicy: failure policy of the function, with boolean `true` being + * @param runtimeOptions Object with optional fields: + * 1. `memory`: amount of memory to allocate to the function, possible values + * are: '128MB', '256MB', '512MB', '1GB', and '2GB'. + * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are + * 0 to 540. + * 3. `failurePolicy`: failure policy of the function, with boolean `true` being * equivalent to providing an empty retry object. - * 2. memory: amount of memory to allocate to the function, with possible - * values being '128MB', '256MB', '512MB', '1GB', and '2GB'. - * 3. timeoutSeconds: timeout for the function in seconds, with possible - * values being 0 to 540. + * 4. `vpcConnector`: id of a VPC connector in the same project and region + * 5. `vpcConnectorEgressSettings`: when a `vpcConnector` is set, control which + * egress traffic is sent through the `vpcConnector`. * * Value must not be null. */ From 0d0f05e6ca16d47ca3657f6ee18080d1d17cf715 Mon Sep 17 00:00:00 2001 From: Eric Gilmore Date: Thu, 29 Oct 2020 14:12:29 -0700 Subject: [PATCH 4/4] Fixing format of toc.yaml file. --- docgen/content-sources/toc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docgen/content-sources/toc.yaml b/docgen/content-sources/toc.yaml index 722b0f818..5758eb74e 100644 --- a/docgen/content-sources/toc.yaml +++ b/docgen/content-sources/toc.yaml @@ -157,4 +157,4 @@ toc: path: /docs/reference/functions/handler_builder_.html section: - title: 'HandlerBuilder' - path: /docs/reference/functions/handler_builder_.handlerbuilder.html \ No newline at end of file + path: /docs/reference/functions/handler_builder_.handlerbuilder.html