-
Notifications
You must be signed in to change notification settings - Fork 116
docs: Secret object/array inputs #1682
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
Conversation
Preview for this PR was built for commit |
|
||
::: | ||
|
||
## Read secret input fields | ||
|
||
When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted (starting with the [`apify` package](https://www.npmjs.com/package/apify) version 3.1.0). | ||
When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted. Decryption of string fields is supported since [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.1.0; support for objects and arrays was added in [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.4.2 and [Python SDK](http://docs.apify.loc/sdk/python/) 2.7.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about the note with starting support for string fields since 3.1.0
is 3 years old
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably safe, it's in the respective git tag: https://github.com/apify/apify-sdk-js/blob/apify%403.1.0/packages/apify/src/actor.ts#L660
Preview for this PR was built for commit |
This comment was marked as spam.
This comment was marked as spam.
|
||
::: | ||
|
||
## Read secret input fields | ||
|
||
When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted (starting with the [`apify` package](https://www.npmjs.com/package/apify) version 3.1.0). | ||
When you read the Actor input through `Actor.getInput()`, the encrypted fields are automatically decrypted. Decryption of string fields is supported since [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.1.0; support for objects and arrays was added in [JavaScript SDK](http://docs.apify.loc/sdk/js/) 3.4.2 and [Python SDK](http://docs.apify.loc/sdk/python/) 2.7.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably safe, it's in the respective git tag: https://github.com/apify/apify-sdk-js/blob/apify%403.1.0/packages/apify/src/actor.ts#L660
sources/platform/actors/development/actor_definition/input_schema/secret_input.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/actor_definition/input_schema/secret_input.md
Outdated
Show resolved
Hide resolved
…ema/secret_input.md Co-authored-by: Michał Olender <[email protected]>
…ema/secret_input.md Co-authored-by: Michał Olender <[email protected]>
Preview for this PR was built for commit |
Preview for this PR was built for commit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo, otherwise LGTM
sources/platform/actors/development/actor_definition/input_schema/secret_input.md
Outdated
Show resolved
Hide resolved
…ema/secret_input.md Co-authored-by: Michał Olender <[email protected]>
Preview for this PR was built for commit |
Add notes about
isSecret
availability forobject
/array
inputs. Context: apify/apify-shared-js#515