[api-request-builder] pass projectKey as main option about nodejs HOT 5 CLOSED

Thinking about this a bit more, if we put it in createRequestBuilder, all services will have the projectKey prefixed. This might be fine for most of the services but there might be some that do not need the projectKey. In that case, having it in build makes it more flexible but kind of verbose to use everytime.

I was thinking maybe of a solution in the middle, where you can explicitly "disable it" on demand.

createRequestBuilder({ projectKey: 'my-project' })
service.users.build({ withProjectKey: false })

Any thoughts?

from nodejs.

Could you give a real-life example of a service which works without the project key? The 'disable' option sounds good to me.

from nodejs.

It's only if you provide custom services, the default services will all use the projectKey (for now) yes.

from nodejs.

This is okay for me too, we will go ahead with this...

from nodejs.

Would this implementation be ok, such that the createRequestBuilder requires the project key and throws if it is omitted, but can then be overridden in the service.users.build with the explicit withProjectKey flag to be used to not send the project key to the server (defaults to true)

createRequestBuilder({ projectKey: '' })
// throws an error

createRequestBuilder({ projectKey: 'my-project' })
service.users.build({ withProjectKey: false })
// doesn't throw but no projectKey in query

createRequestBuilder({ projectKey: 'my-project' })
service.users.build({ withProjectKey: true })
// doesn't throw and projectKey in query

createRequestBuilder({ projectKey: 'my-project' })
service.users.build()
// doesn't throw and projectKey in query

Any thoughts?

from nodejs.