Package com.ibm.commerce.rest.javadoc

  • Interface Summary 
    Interface Description
    Value
    Value structure.
    ValueProvider
    Interface implemented by classes that can supply valid values to the API documentation.
  • Class Summary 
    Class Description
    AbstractJdbcValueProvider
    Used to fetch values and their description based on a JDBC query.
    CurrencyIdProvider
    Used to fetch all the valid currency symbols on the system.
    EmptyValueProvider
    Default value provider used for parameters that don't provide any default values.
    LanguageIdProvider
    Provider that fetches all the language IDs available on the system.
    LocaleProvider
    Class that fetches all the valid locales on the system.
    QueryNameProvider
    Value provider that fetches all the valid query names on a resource handler.
    ResponseType
    Valid response type values.
    StoreIdProvider
    Fetches all the valid store identifiers on the system.
    ValueImpl
    Value structure implementation.
  • Annotation Types Summary 
    Annotation Type Description
    AdditionalParameterList
    Annotation used to add parameters to a REST API method without adding them to the java method signature.
    Authentication Deprecated
    Security requirements are now extracted from the configuration file directly.
    ClassDescription Deprecated
    Use the generic Description annotation instead.
    Description
    Documents the short description of a REST API method.
    InternalConsumes
    Tag used to flag the type of data formats consumed by a method exposed internally.
    InternalHttpMethod
    This annotation is used to expose a method in the REST API documentation even though it might not be the entry point method that wink will use to call the API.
    InternalProduces
    Tag used to identify the produced types produced by a internal method.
    Notes
    Annotation used to add implementation notes to REST APIs.
    ParameterDescription
    Annotation used to describe a parameter used in a REST API.
    QueryParamDocDescription Deprecated
    Each parameter now how has it's own documentation.
    ResponseCode
    Documents the expected response codes of a REST API.
    ResponseSchema
    Document the response schema of a REST API.