Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuration documentation is wrong/confusing + environment variable naming - AUDIENCE #40

Open
vgw-chriskruger opened this issue Jun 14, 2023 · 3 comments

Comments

@vgw-chriskruger
Copy link
Contributor

vgw-chriskruger commented Jun 14, 2023

If I understand correctly the associated documentation for configuring this software is this document.

Within the document is the instructions for configuring the InvokeSalesforceRestAPIFunction lambda function environment variables. See image below.

Screenshot 2023-06-14 at 4 47 00 pm

With reference to the AUDIENCE environment variable the documentation states that one must enter one of the following values:

However upon code inspection it becomes clear that this environment variable is in fact more accurately described as the audience SSM parameter name and one should not enter either of these values directly into the lambda environment variable. The environment variable is the name of the SSM parameter, where one should enter the audience value.

The documentation is wrong and the name of the environment variable is less than ideal. I would argue, it would more accurately reflect reality if it were titled AUDIENCE_PARAM_NAME. The documentation should be updated to reflect the need to edit a parameter in SSM.

@vgw-chriskruger vgw-chriskruger changed the title Configuration documentation is wrong/confusing Configuration documentation is wrong/confusing + environment variable naming - AUDIENCE Jun 16, 2023
@jinalkathiara
Copy link
Contributor

Thanks for pointing this out. We will update this in the documentations.

@vgw-chriskruger
Copy link
Contributor Author

Just noting this is still confusing in Winter `24 documentation

@jinalkathiara
Copy link
Contributor

Apologies for the inconsistencies. I will take a look one more time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants