Package org.eclipse.microprofile.openapi.tck

Class ExternalDocumentationAnnotationTest

java.lang.Object
org.jboss.arquillian.testng.Arquillian
org.eclipse.microprofile.openapi.tck.AppTestBase
org.eclipse.microprofile.openapi.tck.ExternalDocumentationAnnotationTest
All Implemented Interfaces:
org.testng.IHookable, org.testng.ITestNGListener
public class ExternalDocumentationAnnotationTest extends AppTestBase
Verify usage of the @ExternalDocumentation annotation.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.jboss.arquillian.testng.Arquillian

    org.jboss.arquillian.testng.Arquillian.UpdateResultListener

  • Field Summary

    Fields inherited from class org.eclipse.microprofile.openapi.tck.AppTestBase

    YAML_FILTER

    Fields inherited from class org.jboss.arquillian.testng.Arquillian

    ARQUILLIAN_DATA_PROVIDER

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExternalDocumentationAnnotationTest()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.jboss.shrinkwrap.api.spec.WebArchive
    deployment()
     
    void
    testExternalDocumentationAnnotationOnMethod(String type)
    Check that the externalDocs element is present in the generated OpenAPI document when the @ExternalDocumentation annotation is used on a resource method definition.

    Methods inherited from class org.eclipse.microprofile.openapi.tck.AppTestBase

    callEndpoint, configureRestAssured, dereference, dereference, provide

    Methods inherited from class org.jboss.arquillian.testng.Arquillian

    arquillianAfterClass, arquillianAfterSuite, arquillianAfterTest, arquillianArgumentProvider, arquillianBeforeClass, arquillianBeforeSuite, arquillianBeforeTest, run

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ExternalDocumentationAnnotationTest

      public ExternalDocumentationAnnotationTest()

  • Method Details

    • deployment

      @Deployment(name="externalDocs-test", testable=false) public static org.jboss.shrinkwrap.api.spec.WebArchive deployment()

    • testExternalDocumentationAnnotationOnMethod

      public void testExternalDocumentationAnnotationOnMethod(String type)
      Check that the externalDocs element is present in the generated OpenAPI document when the @ExternalDocumentation annotation is used on a resource method definition.
      Parameters:
      type - Type of the OpenAPI output format