Skip navigation links

MicroProfile OpenAPI API v2.0

@Version(value="1.0") @ProviderType

Package org.eclipse.microprofile.openapi.annotations.links

Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked operation.

See: Description

Package org.eclipse.microprofile.openapi.annotations.links Description

Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked operation.

Example usage:

   @APIResponse(
      responseCode="201",
      description="review created",
      links = {
           @Link(
              name="Review",
              description="get the review that was added",
              operationId="getReviewById"
      }
  )
 
Skip navigation links

MicroProfile OpenAPI API v2.0

Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.