Reading custom fields (Graphql)?

[slanelb]

Hello, is it possible to read custom fields within the product model using Graphql SDK or Swell js or must I use the Node library?

[rodrigoddalmeida]

Hi @slanelb, custom fields added to the content namespace are available by default in our Frontend APIs. If you have a custom field out of the content namespace, you need to explicitly add it to your public key's permissions.

This article might help you achieve that: https://developers.swell.is/guides/opening-content-permissions

[steph-query]

Thanks @logeshswell! I have a lot of models that I did not create in the content namespace when i first created them (things like countries, regions, etc. for a taxonomy of geographic wine data that I attached to my products.

I'll stay tuned for this update, but my last question is: Will I/Should I be able to access these fields through the GraphQL API?

For example, when I fetch a product in the dashboard console, I see all the links, including the testId:

{
    "active": true,
    "glassware": "64f3a31a8928410012378661",
    "alcohol": "13%",
    "varieties": "64f39eb9990c1f00123371c1",
    "vineyard": "Vista Luna Vineyard",
    "size": "64f395a5e5a474001109619f",
    "price": 21,
    "description": "Ferdinand is a small winery focusing on Spanish varietals grown in California. The flagship wine is their Albariño, which comes from the Luna Vista vineyard in the Borden Ranch subzone of the Lodi AVA. Albariño offers an interesting combination of floral aromatics and crisp white fruit, and this one spends 8 months on the lees in used oak barrels, giving it a lush texture to balance its mouthwatering acidity.",
    "name": "Ferdinand, California Albariño 'Vista Luna Vineyard 2019 750ml",
    "sku": "prod_0egY5eMRrM53Qn",
    "slug": "ferdinand-california-albario-vista-luna-vineyard-2019-750ml",
    "producer_id": "64f39bfaa5c9ea00110172b5",
    "wine_category_id": "64f3a05e36212500129b43c1",
    "country_id": "64f395cbd66b1f0012720fea",
    ...
    "appellation_id": "64f3998921b14f0012579270",
    "region_id": "64f39604d83b3f00126f169a",
    "fermentation_id": "64f3a0676465720012c3ee45",
    "aging_id": "64f3a0676465720012c3ee45",
    "wine_type_id": "64f39de38bcca80011780af9",
    "date_updated": "2023-10-25T22:43:26.376Z",
    "test_id": "6536cbdae1c822001216c74d",
    "content": {
      "wine_type_id": null
    },
    "id": "64f3b6c8153a160012eb6b13"
}

However, when I run the query you shared (adding product name to the requested fields), I get this response:

{
    "product": {
        "id": "64f3b6c8153a160012eb6b13",
        "name": "Ferdinand, California Albariño 'Vista Luna Vineyard 2019 750ml",
        "content": null
    }
}

When I ask GraphQL for products at the top level (instead of getting to them via products) and try to traverse these relationships, I get the shape back, but no values.

{
    "id": "64f3b6c8153a160012eb6b13",
    "name": "Ferdinand, California Albariño 'Vista Luna Vineyard 2019 750ml",
    "content": {
        "testId": null,
        "wineTypeId": null
    }
}

I'm having trouble making sense of all the different response shapes and values, and how the behavior is meant to change with content models vs custom models in their own namespace.

[logeshswell]

Will I/Should I be able to access these fields through the GraphQL API?

You can retrieve all the fields present under content namespace via GraphQL API.

[logeshswell]

Please refer to the DOCS section inside the GraphQL playground to understand the possible response schema:
https://somm-demand.swell.store/playground

[steph-query]

Thanks, what I've realized is that switching a field to move it under the content namespace clears it from the existing products! So if I had selected a country, for example, that link would disappear when I changed the country field to be content.country. It is unfortunate that I will have to re-connect all of my products to their related countries/regions/etc. when I change the namespace on the field- is this intended?

That said, getting country ID from GraphQL does seem to work without actually dropping the custom countries model I made, meaning I don't think I have to recreate them all as content models, I only need to change the field on products that links to the custom model (at least to get the country ID from graphQL).

I'll be eagerly awaiting the updates that will allow me to use GraphQL to fetch actual attributes on the custom content models via the product fields, so please do let me know when that is available. Hopefully I don't have to go and re-create/re-link everything.

[logeshswell]

when I change the namespace on the field- is this intended?

Yes, you need to migrate the values before the migration. I will keep you posted when we fix this gap.