Skip to content

fix: APAC region documentation and test expectations #240

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 3, 2025
Merged

fix: APAC region documentation and test expectations #240

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fe320e
Fix APAC region documentation and test expectations
Oct 3, 2025
6d528a7
fix: make the error message match exactly
shazron Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ OpenWhisk credentials can also be read from environment variables `__OW_NAMESPAC
| --- | --- | --- |
| [config] | <code>object</code> | used to init the sdk |
| [config.ow] | [<code>OpenWhiskCredentials</code>](#OpenWhiskCredentials) | [OpenWhiskCredentials](#OpenWhiskCredentials). Set those if you want to use ootb credentials to access the state management service. OpenWhisk namespace and auth can also be passed through environment variables: `__OW_NAMESPACE` and `__OW_API_KEY` |
| [config.region] | <code>string</code> | optional region to use, accepted values: `amer` (default), `emea` |
| [config.region] | <code>string</code> | optional region to use, accepted values: `amer` (default), `emea`, `apac` |

<a name="AdobeStateCredentials"></a>

Expand Down
2 changes: 1 addition & 1 deletion lib/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const { AdobeState } = require('./AdobeState')
* to use ootb credentials to access the state management service. OpenWhisk
* namespace and auth can also be passed through environment variables:
* `__OW_NAMESPACE` and `__OW_API_KEY`
* @param {string} [config.region] optional region to use, accepted values: `amer` (default), `emea`
* @param {string} [config.region] optional region to use, accepted values: `amer` (default), `emea`, `apac`
* @returns {Promise<AdobeState>} An AdobeState instance
*/
async function init (config = {}) {
Expand Down
2 changes: 1 addition & 1 deletion test/AdobeState.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,7 @@ describe('private methods', () => {
mockCLIEnv.mockReturnValue(env)

await expect(AdobeState.init({ ...fakeCredentials, region })).rejects
.toThrow('[AdobeStateLib:ERROR_BAD_ARGUMENT] /region must be equal to one of the allowed values: amer, emea')
.toThrow('[AdobeStateLib:ERROR_BAD_ARGUMENT] /region must be equal to one of the allowed values: amer, emea, apac')
})
})

Expand Down
2 changes: 1 addition & 1 deletion types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ export type OpenWhiskCredentials = {
* to use ootb credentials to access the state management service. OpenWhisk
* namespace and auth can also be passed through environment variables:
* `__OW_NAMESPACE` and `__OW_API_KEY`
* @param [config.region] - optional region to use, accepted values: `amer` (default), `emea`
* @param [config.region] - optional region to use, accepted values: `amer` (default), `emea`, `apac`
* @returns An AdobeState instance
*/
export function init(config?: {
Expand Down