Skip to content

Commit 584d232

Browse files
committed
Update README to add info about types and version
1 parent cbf1cd7 commit 584d232

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ An auto-generated [documentation site](https://salesforcecommercecloud.github.io
2424
1. **Type Access**: API class types are accessible through the `<api_class>Types` namespace (e.g., `ShopperProductsTypes`). Individual types can be accessed as `ShopperProductsTypes.Product`.
2525
2. **Type References**: The `References` section under API classes in the generated documentation may show duplicate entries. This occurs because types are exported both at their original definition and under the API class namespace. Both references point to the same underlying type definition.
2626
3. **V4 Migration Guide**: Starting in v5, API classes will no longer be exported under API family namespaces. See the [Sample Code](#sample-code) section for migration examples.
27+
4. **Supporting Files**: The SDK includes additional supporting modules beyond the `helpers` SLAS functions. The `types` module provides common type definitions shared across API classes, while the `version` module automatically implements user agent headers for all requests. The user agent value follows the format `commerce-sdk@<version>` based on the current SDK version.
2728

2829
## :warning: Planned API Changes :warning:
2930

docs/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ <h3>Navigating the Documentation</h3>
9090
<li><strong>Type Access</strong>: API class types are accessible through the <code>&lt;api_class&gt;Types</code> namespace (e.g., <code>ShopperProductsTypes</code>). Individual types can be accessed as <code>ShopperProductsTypes.Product</code>.</li>
9191
<li><strong>Type References</strong>: The <code>References</code> section under API classes in the generated documentation may show duplicate entries. This occurs because types are exported both at their original definition and under the API class namespace. Both references point to the same underlying type definition.</li>
9292
<li><strong>V4 Migration Guide</strong>: Starting in v5, API classes will no longer be exported under API family namespaces. See the <a href="#sample-code">Sample Code</a> section for migration examples.</li>
93+
<li><strong>Supporting Files</strong>: The SDK includes additional supporting modules beyond the <code>helpers</code> SLAS functions. The <code>types</code> module provides common type definitions shared across API classes, while the <code>version</code> module automatically implements user agent headers for all requests. The user agent value follows the format <code>commerce-sdk@&lt;version&gt;</code> based on the current SDK version.</li>
9394
</ol>
9495
<a href="#warning-planned-api-changes-warning" id="warning-planned-api-changes-warning" style="color: inherit; text-decoration: none;">
9596
<h2>:warning: Planned API Changes :warning:</h2>
@@ -622,7 +623,7 @@ <h2>Security</h2>
622623
<p>For more information about security considerations related to developing headless commerce applications, see
623624
<a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/security-considerations-for-headless-commerce.html">Security Considerations for Headless Commerce</a> on the
624625
<a href="https://developer.salesforce.com/developer-centers/commerce-cloud">Commerce Cloud Developer Center</a>.</p>
625-
<p>If you discover any potential security issues, please report them to <a href="mailto:&#115;&#101;&#99;&#117;&#114;&#105;&#x74;&#121;&#x40;&#115;&#97;&#x6c;&#x65;&#115;&#x66;&#111;&#x72;&#99;&#101;&#x2e;&#x63;&#111;&#109;">&#115;&#101;&#99;&#117;&#114;&#105;&#x74;&#121;&#x40;&#115;&#97;&#x6c;&#x65;&#115;&#x66;&#111;&#x72;&#99;&#101;&#x2e;&#x63;&#111;&#109;</a> as soon as possible.</p>
626+
<p>If you discover any potential security issues, please report them to <a href="mailto:&#x73;&#101;&#x63;&#117;&#114;&#105;&#116;&#121;&#64;&#x73;&#x61;&#x6c;&#x65;&#115;&#x66;&#111;&#x72;&#99;&#x65;&#x2e;&#x63;&#x6f;&#x6d;">&#x73;&#101;&#x63;&#117;&#114;&#105;&#116;&#121;&#64;&#x73;&#x61;&#x6c;&#x65;&#115;&#x66;&#111;&#x72;&#99;&#x65;&#x2e;&#x63;&#x6f;&#x6d;</a> as soon as possible.</p>
626627
<a href="#additional-documentation" id="additional-documentation" style="color: inherit; text-decoration: none;">
627628
<h2>Additional Documentation</h2>
628629
</a>

0 commit comments

Comments
 (0)