com.ibm.commerce.rest.javadoc

Annotation Type ResponseSchema


  • @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ResponseSchema
    Document the response schema of a REST API.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.String parameterGroup 
      java.lang.String profile
      The profile used in the response description.
      java.lang.String resourceName 
      java.lang.Class valueClass 
      com.ibm.commerce.rest.javadoc.ClassType valueClassType
      The value class type.
      java.lang.String valueSamplePath 

    • Element Detail

      • responseCodes

        public abstract ResponseCode[] responseCodes
        Returns:
        The list of response codes that might be returned by the API.

      • parameterGroup

        public abstract java.lang.String parameterGroup
        Returns:
        The parameter group used in the commerce BOD mapping configuration.
        Default:
        ""

      • resourceName

        public abstract java.lang.String resourceName
        Returns:
        The resource name used in the commerce BOD mapping configuration.
        Default:
        ""

      • valueClass

        public abstract java.lang.Class valueClass
        Returns:
        The java class containing fields and annotation that can be used to document the response. Defaults to Void.class if none is specified.
        Default:
        java.lang.Void.class

      • valueClassType

        public abstract com.ibm.commerce.rest.javadoc.ClassType valueClassType
        The value class type.
        Returns:
        The value class type.
        Default:
        com.ibm.commerce.rest.javadoc.ClassType.Pojo

      • profile

        public abstract java.lang.String profile
        The profile used in the response description.
        Returns:
        The profile used in the response description.
        Default:
        ""

      • valueSamplePath

        public abstract java.lang.String valueSamplePath
        Returns:
        Resource path of the sample to reverse engineer to document the schema. Only used if parameterGroup and valueClass isn't specified.
        Default:
        ""
Skip navigation links