[HTTP] versionResolution doc comment with information about internal routes (#171971)

This commit is contained in:
Jean-Louis Leysens 2023-11-30 08:39:32 +02:00 committed by GitHub
parent 4f10d4477b
commit df6e8ddaed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -178,9 +178,10 @@ const configSchema = schema.object(
versioned: schema.object({
/**
* Which handler resolution algo to use: "newest" or "oldest".
* Which handler resolution algo to use for public routes: "newest" or "oldest".
*
* @note in development we have an additional option "none" which is also the default.
* @note Internal routes always require a version to be specified.
* @note in development we have an additional option "none" which is also the default in dev.
* This prevents any fallbacks and requires that a version specified.
* Useful for ensuring that a given client always specifies a version.
*/