Some Instance schema URI is missing in Collection schema URI

AMI_alvin
Minnow

Posts: 20

Some Instance schema URI is missing in Collection schema URI Feb 22, 2021 3:30:29 GMT

Quote

Post by AMI_alvin on Feb 22, 2021 3:30:29 GMT

Hi,

I found some wired cases about the relation between Collection and Instance schema URIs.

For example, NetworkPortCollection.json schema includes these uris :

"/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts",

"/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts",
...
...

But in NetworkPort.json schema, there is only one uri :

"/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts/{NetworkPortId}"

And this is not a single case, I also found NetworkDeviceFunction and NetworkDeviceFunctionCollection have the same problem.

Is there any reason for this design?

Thanks,
Alvin

mraineri
Administrator

Posts: 1,048

Some Instance schema URI is missing in Collection schema URI Feb 23, 2021 21:04:33 GMT AMI_alvin likes this

Quote

Post by mraineri on Feb 23, 2021 21:04:33 GMT

Yes, those URI patterns are accurate. The intent is the members of "NetworkPorts" within "NetworkInterface" will point to the NetworkPort instances underneath Chassis. So, your "NetworkPortCollection" underneath systems will look like this:

{
    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/1/NetworkPorts",
    "@odata.type": "#NetworkPortCollection.NetworkPortCollection",
    "Name": "Network ports for interface 1",
    "Members": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Adapter1/NetworkPorts/1"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Adapter1/NetworkPorts/2"
        }
    ]
}

The same is true for NetworkDeviceFunctions. The reason for this is to allow for complex types of designs where physical ports and functions can be shared by multiple systems. So, in order to prevent duplication of resources, the collections under a given system will ultimately point back to their physical representation under chassis. I think we can add some additional language in the descriptions in NetworkInterface to make this clear.

We also have a YouTube video that explains this model here: www.youtube.com/watch?v=jJeHgvnUc3w

AMI_alvin Minnow Posts: 20	Some Instance schema URI is missing in Collection schema URI Feb 25, 2021 3:25:26 GMT Quote Select Post Deselect Post Link to Post Back to Top Post by AMI_alvin on Feb 25, 2021 3:25:26 GMT Okay, this makes sense. And yes I think it will be helpful if you can add some descriptions for this purpose. Thanks for your reply!

Some Instance schema URI is missing in Collection schema URI

Post by AMI_alvin on Feb 22, 2021 3:30:29 GMT

Post by mraineri on Feb 23, 2021 21:04:33 GMT

Post by AMI_alvin on Feb 25, 2021 3:25:26 GMT