Skip to content

Commit 1a734cf

Browse files
authored
Update
1 parent db2b3df commit 1a734cf

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/api/registration-base-url-resource.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Name | Type | Required | Notes
225225
---------------- | ---------------- | -------- | -----
226226
reasons | array of strings | yes | The reasons why the package was deprecated
227227
message | string | no | The additional details about this deprecation
228-
alternatePackage | object | no | The [package dependency](#package-dependency) that should be used instead
228+
alternatePackage | object | no | The alternate package that should be used instead
229229

230230
The `reasons` property must contain at least one string and should only contains strings from the following table:
231231

@@ -235,6 +235,14 @@ Legacy | The package is no longer maintained
235235
CriticalBugs | The package has bugs which make it unsuitable for usage
236236
Other | The package is deprecated due to a reason not on this list
237237

238+
The `alternatePackage` property has the following properties:
239+
240+
Name | Type | Required | Notes
241+
------------ | ------ | -------- | -----
242+
id | string | yes | The ID of the package dependency
243+
range | object | no | The allowed [version range](../concepts/package-versioning.md#version-ranges-and-wildcards), or `*` if all versions are allowed
244+
registration | string | no | The URL to the registration index for this dependency
245+
238246
If the `reasons` property contains strings that are not from the known set, they should be ignored. The strings are case-insensitive, so `legacy` should be treated the same as `Legacy`. There is no ordering restriction on the array, so the strings can arranged in any arbitrary order. Additionally, if the property contains only strings that are not from the known set, it should be treated as if it only contained the "Other" string.
239247

240248
### Sample request

0 commit comments

Comments
 (0)