Package io.swagger.v3.oas.annotations.links

Annotation Type Link

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String description
      A description of the link.
      Extension[] extensions
      The list of optional extensions
      String name
      The name of this link.
      String operationId
      The name of an existing, resolvable OAS operation, as defined with a unique operationId.
      String operationRef
      A relative or absolute reference to an OAS operation.
      LinkParameter[] parameters
      Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
      String ref
      A reference to a link defined in components links.
      String requestBody
      A literal value or {expression} to use as a request body when calling the target operation.
      Server server
      An alternative server to service this operation.

    • Element Detail

      • name

        String name
        The name of this link.
        Returns:
        the link's name
        Default:
        ""

      • operationRef

        String operationRef
        A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and must point to an Operation Object. Relative operationRef values may be used to locate an existing Operation Object in the OpenAPI definition. Ignored if the operationId property is specified.
        Returns:
        an operation reference
        Default:
        ""

      • operationId

        String operationId
        The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.
        Returns:
        an operation ID
        Default:
        ""

      • parameters

        LinkParameter[] parameters
        Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
        Returns:
        the list of parameters for this link
        Default:
        {}

      • description

        String description
        A description of the link. CommonMark syntax may be used for rich text representation.
        Returns:
        the link's description
        Default:
        ""

      • requestBody

        String requestBody
        A literal value or {expression} to use as a request body when calling the target operation.
        Returns:
        the request body of this link
        Default:
        ""

      • server

        Server server
        An alternative server to service this operation.
        Returns:
        the server associated to this link
        Default:
        @io.swagger.v3.oas.annotations.servers.Server

      • extensions

        Extension[] extensions
        The list of optional extensions
        Returns:
        an optional array of extensions
        Default:
        {}

      • ref

        String ref
        A reference to a link defined in components links.
        Returns:
        the reference
        Since:
        2.0.3
        Default:
        ""