Package dk.mada.jaxrs.model.api

Interface Operation

@Immutable public interface Operation
Information about a single operation.

  • Method Details

    • builder

      static dk.mada.jaxrs.model.api.ImmutableOperation.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • path

      String path()
      Returns the operation resource path.
      Returns:
      the operation resource path

    • httpMethod

      HttpMethod httpMethod()
      Returns the operation HTTP method.
      Returns:
      the operation HTTP method

    • tags

      List<String> tags()
      Returns the operation tags.
      Returns:
      the operation tags

    • operationId

      Optional<String> operationId()
      Returns an optional operation id.
      Returns:
      an optional operation id

    • syntheticOpId

      String syntheticOpId()
      Returns a synthetic operation id computed by path and http type.
      Returns:
      a synthetic operation id computed by path and http type

    • description

      Optional<String> description()
      Returns an optional description of the operation.
      Returns:
      an optional description of the operation

    • summary

      Optional<String> summary()
      Returns an optional summary of the operation.
      Returns:
      an optional summary of the operation

    • deprecated

      boolean deprecated()
      Returns true if the operation is deprecated.
      Returns:
      true if the operation is deprecated

    • responses

      List<Response> responses()
      Returns the operation responses.
      Returns:
      the operation responses

    • parameters

      List<Parameter> parameters()
      Returns the operation parameters.
      Returns:
      the operation parameters

    • requestBody

      Optional<RequestBody> requestBody()
      Returns the optional request body.
      Returns:
      the optional request body

    • isVoid

      default boolean isVoid()
      Returns true if all responses on the operation are void.
      Returns:
      true if all responses on the operation are void

    • addAuthorizationHeader

      boolean addAuthorizationHeader()
      Returns true if this operation requires an authentication parameter.
      Returns:
      true if this operation requires an authentication parameter

    • group

      default String group()
      Returns the (first) group of an operation.
      Returns:
      the (first) group of an operation