Class DocumentationPartLocation


  • public final class DocumentationPartLocation
    extends java.lang.Object
    • Method Detail

      • method

        public java.util.Optional<java.lang.String> method()
        Returns:
        HTTP verb of a method. The default value is `*` for any method.
      • name

        public java.util.Optional<java.lang.String> name()
        Returns:
        Name of the targeted API entity.
      • path

        public java.util.Optional<java.lang.String> path()
        Returns:
        URL path of the target. The default value is `/` for the root resource.
      • statusCode

        public java.util.Optional<java.lang.String> statusCode()
        Returns:
        HTTP status code of a response. The default value is `*` for any status code.
      • type

        public java.lang.String type()
        Returns:
        Type of API entity to which the documentation content appliesE.g., `API`, `METHOD` or `REQUEST_BODY`