APIPropertyAnnotation (Axway API-Manager CLI API-Manager Adapter 1.13.8 API)

@Retention(RUNTIME)
@Target(FIELD)
public @interface APIPropertyAnnotation

Required Element Summary

Required Elements
Modifier and Type Required Element Description

String[] writableStates

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`boolean`	`copyProp`	This property should be set to false for all properties, not managed directly by the API-Proxy endpoint.
`boolean`	`isBreaking`	Controls if an API-Property would potentially lead to a breaking change.
`boolean`	`isRecreate`	If set to true, a change to this API-Property will force the API to be re-created.

- Element Detail
  - writableStates
```
String[] writableStates
```
    Returns:
    
    an Array of states this API property can be changed
- - isBreaking
```
boolean isBreaking
```
    Controls if an API-Property would potentially lead to a breaking change.
    
    Returns:
    
    true, if the API property can break client applications.
    
    Default:
    
    false
- - isRecreate
```
boolean isRecreate
```
    If set to true, a change to this API-Property will force the API to be re-created. For instance, when the OpenAPI/Swagger spec is changed.
    
    Returns:
    
    true if a change to this API-Property must re-create the API. Defaults to false
    
    Default:
    
    false
- - copyProp
```
boolean copyProp
```
    This property should be set to false for all properties, not managed directly by the API-Proxy endpoint. For instance clientOrganization, applications, etc. This properties should stay in the DesiredAPI and not copied into the Actual-API to make decisions possible, about what to do (for instance which organizations to remove or add)
    
    Returns:
    
    true, if the property will be copied from the Desired to the Actual API. If false, the property is not copied.
    
    Default:
    
    true