Class DocInfoCommonValues


  • public class DocInfoCommonValues
    extends Object
    This class contains common constants used for API documentation. These constants are typically used for documentation purposes, such as defining response formats, error messages, and sample data.

    The constants defined in this class help maintain consistency across the application when documenting API responses and behaviors.

    Author:
    nikritikos
    • Field Detail

      • DOC_APPLICATION_JSON

        public static final String DOC_APPLICATION_JSON
        The standard content type for JSON responses.
        See Also:
        Constant Field Values
      • DOC_DETAIL_LEVEL_PARAM

        public static final String DOC_DETAIL_LEVEL_PARAM
        Description for the detail level parameter, which determines the level of detail in the API response. If not provided, the default response will use the "SIMPLE" level.
        See Also:
        Constant Field Values
      • DOC_ERROR_NOT_FOUND

        public static final String DOC_ERROR_NOT_FOUND
        Error message when the requested resource is not found.
        See Also:
        Constant Field Values
      • DOC_ERROR_VALIDATION

        public static final String DOC_ERROR_VALIDATION
        Error message for validation failures.
        See Also:
        Constant Field Values
      • DOC_ERROR_CONFLICT

        public static final String DOC_ERROR_CONFLICT
        Error message for conflicts, typically when a resource already exists.
        See Also:
        Constant Field Values
      • DOC_QCCODE_SAMPLE

        public static final String DOC_QCCODE_SAMPLE
        A sample QCCode, which can be used for testing or demonstration purposes.
        See Also:
        Constant Field Values