Skip to content

fix: correct asset_fields[] parameter names for DAM 2.0 #337

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
AniketDev7 merged 1 commit into from
Feb 27, 2026
Merged

fix: correct asset_fields[] parameter names for DAM 2.0 #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/assets/asset.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,14 @@ export class Asset {
* @method assetFields
* @memberof Asset
* @description Include specific asset fields in the response (CDA getAssets - single asset).
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
* @example
* import contentstack from '@contentstack/delivery-sdk'
*
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
* const result = await stack.asset("assetUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
*
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
* @returns {Asset} - Returns the Asset instance for chaining.
*/
assetFields(...fields: string[]): this {
Expand Down
4 changes: 2 additions & 2 deletions src/entries/entries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,14 +281,14 @@ export class Entries extends BaseQuery {
* @method assetFields
* @memberof Entries
* @description Include specific asset fields in the response (CDA getEntry/entries).
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
* @example
* import contentstack from '@contentstack/delivery-sdk'
*
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
* const result = await stack.contentType("contentTypeUid").entry().assetFields("user_defined_fields", "embedded_metadata").find();
*
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
* @returns {Entries} - Returns the Entries instance for chaining.
*/
assetFields(...fields: string[]): this {
Expand Down
4 changes: 2 additions & 2 deletions src/entries/entry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,14 +278,14 @@ export class Entry {
* @method assetFields
* @memberof Entry
* @description Include specific asset fields in the response (CDA getEntry).
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
* @example
* import contentstack from '@contentstack/delivery-sdk'
*
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
* const result = await stack.contentType("contentTypeUid").entry("entryUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
*
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
* @returns {Entry} - Returns the Entry instance for chaining.
*/
assetFields(...fields: string[]): this {
Expand Down
4 changes: 2 additions & 2 deletions src/query/asset-query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,14 @@ export class AssetQuery extends BaseQuery {
* @method assetFields
* @memberof AssetQuery
* @description Include specific asset fields in the response (CDA getAssets).
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
* @example
* import contentstack from '@contentstack/delivery-sdk'
*
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
* const result = await stack.asset().assetFields("user_defined_fields", "embedded_metadata").find();
*
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
* @returns {AssetQuery} - Returns the AssetQuery instance for chaining.
*/
assetFields(...fields: string[]): this {
Expand Down
2 changes: 1 addition & 1 deletion test/api/asset-query.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ describe("AssetQuery API tests", () => {
});
it("should query assets with asset_fields[] CDA param (user_defined_fields, embedded, ai_suggested, visual_markups)", async () => {
const result = await makeAssetQuery()
.assetFields("user_defined_fields", "embedded_metadata", "ai_suggested", "visual_markups")
.assetFields("user_defined_fields", "embedded_metadata", "ai_generated_metadata", "visual_markups")
.limit(2)
.find<TAsset>();
if (result.assets) {
Expand Down
2 changes: 1 addition & 1 deletion test/api/asset.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ describe('Asset API tests', () => {

it('should fetch asset with asset_fields[] CDA param (user_defined_fields, embedded_metadata, ai_suggested, visual_markups)', async () => {
const result = await makeAsset(assetUid)
.assetFields('user_defined_fields', 'embedded_metadata', 'ai_suggested', 'visual_markups')
.assetFields('user_defined_fields', 'embedded_metadata', 'ai_generated_metadata', 'visual_markups')
.fetch<BaseAsset>();
expect(result).toBeDefined();
expect(result.uid).toBeDefined();
Expand Down
2 changes: 1 addition & 1 deletion test/api/entries.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ describe("Entries API test cases", () => {

it("should query entries with asset_fields[] CDA param (user_defined_fields, embedded, ai_suggested, visual_markups)", async () => {
const result = await makeEntries(BLOG_POST_CT)
.assetFields("user_defined_fields", "embedded_metadata", "ai_suggested", "visual_markups")
.assetFields("user_defined_fields", "embedded_metadata", "ai_generated_metadata", "visual_markups")
.find<TEntry>();
if (result.entries) {
expect(result.entries).toBeDefined();
Expand Down
2 changes: 1 addition & 1 deletion test/api/entry.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ describe('Entry API tests', () => {

it('should fetch entry with asset_fields[] CDA param (user_defined_fields, embedded, ai_suggested, visual_markups)', async () => {
const result = await makeEntry(entryUid)
.assetFields('user_defined_fields', 'embedded', 'ai_suggested', 'visual_markups')
.assetFields('user_defined_fields', 'embedded_metadata', 'ai_generated_metadata', 'visual_markups')
.fetch<TEntry>();
expect(result).toBeDefined();
expect(result.uid).toBeDefined();
Expand Down