IBM / ibm-cos-sdk-js

ibm-cos-sdk-js
Apache License 2.0
38 stars 20 forks source link

"Working with Services" in the Getting Started Guide link is broken #73

Closed mriedem closed 3 years ago

mriedem commented 3 years ago

The link in the docs under params here https://ibm.github.io/ibm-cos-sdk-js/AWS/S3.html#constructor-property links to https://ibm.github.io/AWSJavaScriptSDK/guide/node-services.html#Bound_Parameters which does not exist.

My guess is that should be linking to something like what's in https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/.

cloudpitchford commented 3 years ago

I can't assign this myself but I can see that services bound to buckets no longer need the bucket parameter spelled out.

The closed analogue for describing the intended behavior is: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/creating-and-calling-service-objects.html#specifying-service-object-parameters

From the S3 Config, I think I have the right target for the URL: https://ibm.github.io/ibm-cos-sdk-js/AWS/Config.html

mriedem commented 3 years ago

but I can see that services bound to buckets no longer need the bucket parameter spelled out.

Is this because you can specify a bucket-specific endpoint and pass s3BucketEndpoint: true? I'm new to all of this so just trying to catch up. I'm also not sure what the default value is for s3BucketEndpoint since it's not mentioned in the docs.

mriedem commented 3 years ago

I'm also not sure what the default value is for s3BucketEndpoint since it's not mentioned in the docs.

I guess it defaults to false: https://github.com/IBM/ibm-cos-sdk-js/blob/6362a3a391068b324eb2c3621a51f05c2e006929/ts/config.ts#L71

cloudpitchford commented 3 years ago

If I understand correctly, the bound parameters would override those defaults, but allow services to define their own values.

IBMeric commented 3 years ago

The broken link is inherited from upstream. We will remove the hardcode in a future release.

IBMeric commented 3 years ago

This issue has been addressed in the 1.8.0 release. Please verify and close the ticket.

mriedem commented 3 years ago

I see the misleading link is gone so this looks OK to me:

image