Deprecate

This element contains the deprecation details (i.e., the outdated or no longer supported information) of the resource.

Possible Locations

Child Elements

Description

Attributes

Name	Type	Description
alternate	String	The replacement url related to the deprecated API operation. This will be added to the help document.
since required	String	The version number that corresponds to the deprecated version.
for-removal	Boolean	Indicate whether deprecation will occur in the next immediate version. true: Deprecation will take place in the immediate next version. false: Deprecation will not take place in the next version.

Example

Imagine that in the trips resource, we want to deprecate the <property>, adventure_activities from version 2 and from version 3 the property will be removed. This is the replacement URL www.travel_bureau.com/propertyreplacementurl.html for the property.

Here is how you have to write the deprecate element for the property adventure_activities.

    
        copy
        
            
        
    
    
         
<property name="adventure_activities" type="collections">
    <deprecate alternate="www.travel_bureau.com/Propertyreplacementurl.html" since="v2" for-removal="true" />
</property>

Last Updated 2025-05-30 16:54:59 +0530 +0530

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit