Change parameter in function calls

[tcnt]

Signed-off-by: Theo Thomas [email protected]

Description

The notebook previously called
queryKnownServers(platformName, platformServicesURLRoot)
queryActiveServers(platformName, platformServicesURLRoot)

The functions defined in common/environment-check.ipynb expects the url+portnumber which is in
platformURLroot.
Then function will internally generate platformServicesURLRoot.

Renamed platformURLroot to serverPlatformURL to align with the
name used internally in the function.
Changed function call parameter to serverPlatformURL in
place of platformServicesURLRoot
Changed function call parameter to platformURLroot in
place of platformServicesURLRoot

Fixes #5023

How Has This Been Tested?

Tested on my local kubernetes running on Raspberry PI 4's.
queryKnownServers(platformName, platformURLroot)
queryActiveServers(platformName, platformURLroot)
results in:
Querying the known servers on platform: Data Lake Platform ...
GET https://lab-datalake:9443/open-metadata/platform-services/users/garygeeke/server-platform/servers
Response:
{
"class": "ServerListResponse",
"relatedHTTPCode": 200,
"serverList": [
"governDL01",
"exchangeDL01",
"cocoMDS1",
"cocoMDS4",
"cocoOLS1",
"cocoView1"
]
}

Querying the active servers on platform: Data Lake Platform ...
GET https://lab-datalake:9443/open-metadata/platform-services/users/garygeeke/server-platform/servers/active
Response:
{
"class": "ServerListResponse",
"relatedHTTPCode": 200,
"serverList": [
"governDL01",
"exchangeDL01",
"cocoMDS1",
"cocoMDS4",
"cocoOLS1",
"cocoView1"
]
}

Any additional notes for reviewers?

[davidradl]

@tcnt Please could you raise an issue associated with this pr that describes the need for the change.

[tcnt]

@tcnt Please could you raise an issue associated with this pr that describes the need for the change.

As mentioned in the beginning this is for #5023 so there is already an issue for this.

[davidradl]

@tcnt I am hoping to get some consensus on this one.

@mandy-chessell @planetf1 I think the existing platformURLroot is better than serverPlatformURL. Personally I would bring the internal names in line with platformURLroot . What do you think? Both words seem to be used in Egeria repo - with slightly more use of platformURLroot. In the docs repo - 20 hits on the word PlatformURLroot, 2 on serverPlatformURL.

[planetf1]

On terminology generally, I think it's probably best to stick with platformURLroot, since that starting point for all our URLs is the platform URL. So you could perhaps just use platformURL instead, but then we always augment it for the particular endpoint, so root is right. Including 'server' in the name is just as technically correct as it's the root for any server requests, but I think it seems more confusing? So I would revert that rename?

[tcnt]

Renaming is reverted now. After all explanations it makes sense to me.
Thanks for all the comments.

[planetf1]

looks good fix