Changelog

upcoming 6.5.0 [Planned December 2025]

Breaking change : NetworkNodes representation change

The endpoint GET /network_nodes described in Working with chains will change in the 6.5.0 release planned mid-december 2025.

WARNING

This change will happen overnight, we strongly recommend that you adapt your calls in a way that they are able to handle both schemas depending on the one your receive, this way your integration won't break and you won't have to sync with our delivery window.

INFO

You will have the opportunity to view this new representation in action in early December (Starting Monday 8th)

The children property was a nested array, now it's a simple list of NetworkNodes IRIs

Before

You had to iterate on each children level do find the club's ones

{
    "@context": "\/demoapi\/contexts\/NetworkNode",
    "@id": "\/demoapi\/network_nodes",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "\/demoapi\/network_nodes\/1433",
            "@type": "NetworkNode",
            "id": 1433,
            "name": "Siège",
            "alias": null,
            "type": "group",
            "clubId": null,
            "children": [
                {
                    "@id": "\/demoapi\/network_nodes\/1434",
                    "@type": "NetworkNode",
                    "id": 1434,
                    "name": "Franchisé",
                    "alias": null,
                    "type": "group",
                    "clubId": null,
                    "children": [
                        {
                            "@id": "\/demoapi\/network_nodes\/1436",
                            "@type": "NetworkNode",
                            "id": 1436,
                            "name": "Config Franchisés",
                            "alias": null,
                            "type": "franchise",
                            "clubId": null,
                            "children": [
                                {
                                    "@id": "\/demoapi\/network_nodes\/1438",
                                    "@type": "NetworkNode",
                                    "id": 1438,
                                    "name": "Arthémis",
                                    "alias": "arthemis",
                                    "type": "club",
                                    "clubId": "\/demoapi\/clubs\/1356",
                                    "children": []
                                },
                                {
                                    "@id": "\/demoapi\/network_nodes\/1439",
                                    "@type": "NetworkNode",
                                    "id": 1439,
                                    "name": "Bacchus",
                                    "alias": "bacchus",
                                    "type": "club",
                                    "clubId": "\/demoapi\/clubs\/1357",
                                    "children": []
                                },
                                // ...
                            ]
                        }
                    ]
                },
                // ...
            ]
        },
        {
            "@id": "\/demoapi\/network_nodes\/1434",
            "@type": "NetworkNode",
            "id": 1434,
            "name": "Franchisé",
            "alias": null,
            "type": "group",
            "clubId": null,
            "children": [
                {
                    //...
                }
            ]
        },
        //...
    ],
    // ...
}

After

All network-nodes are at the same root level, we know how is a children of who by reading the children array[<string>] property

{
    "@context": "\/demoapi\/contexts\/NetworkNode",
    "@id": "\/demoapi\/network_nodes",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "\/demoapi\/network_nodes\/1433",
            "@type": "NetworkNode",
            "id": 1433,
            "name": "Siège",
            "alias": null,
            "type": "group",
            "clubId": null,
            "children": [
              "\/demoapi\/network_nodes\/1434"
              // ...
            ]
        },
        {
            "@id": "\/demoapi\/network_nodes\/1436",
            "@type": "NetworkNode",
            "id": 1436,
            "name": "Config Franchisés",
            "alias": null,
            "type": "franchise",
            "clubId": null,
            "children": [
              "\/demoapi\/network_nodes\/1438",
              "\/demoapi\/network_nodes\/1439"
              // ...
            ]
        }
        {
            "@id": "\/demoapi\/network_nodes\/1438",
            "@type": "NetworkNode",
            "id": 1438,
            "name": "Arthémis",
            "alias": "arthemis",
            "type": "club",
            "clubId": "\/demoapi\/clubs\/1356",
            "children": []
        },
        {
            "@id": "\/demoapi\/network_nodes\/1439",
            "@type": "NetworkNode",
            "id": 1439,
            "name": "Bacchus",
            "alias": "bacchus",
            "type": "club",
            "clubId": "\/demoapi\/clubs\/1357",
            "children": []
        },
        {
            "@id": "\/demoapi\/network_nodes\/1434",
            "@type": "NetworkNode",
            "id": 1434,
            "name": "Franchisé",
            "alias": null,
            "type": "group",
            "clubId": null,
            "children": [
                //...
            ]
        },
        //...
    ],
    // ...
}