Examples with APIResponseImpl fish.payara.microprofile.openapi.impl.model.responses.APIResponseImpl used on opensource projects

Example 6 with APIResponseImpl

use of fish.payara.microprofile.openapi.impl.model.responses.APIResponseImpl in project Payara by payara.

the class ApplicationProcessor method visitAPIResponse.

@Override
public void visitAPIResponse(AnnotationModel annotation, AnnotatedElement element, ApiContext context) {
    APIResponseImpl apiResponse = APIResponseImpl.createInstance(annotation, context);
    Operation workingOperation = context.getWorkingOperation();
    // Handle exception mappers
    if (workingOperation == null) {
        if (element instanceof MethodModel && "toResponse".equals(element.getName())) {
            final MethodModel methodModel = (MethodModel) element;
            final String exceptionType = methodModel.getParameter(0).getTypeName();
            mapException(context, exceptionType, apiResponse);
        } else {
            LOGGER.warning("Unrecognised annotation position at: " + element.shortDesc());
        }
        return;
    }
    APIResponsesImpl.merge(apiResponse, workingOperation.getResponses(), true, context);
    // If an APIResponse has been processed that isn't the default
    String responseCode = apiResponse.getResponseCode();
    if (responseCode != null && !responseCode.isEmpty() && !responseCode.equals(APIResponses.DEFAULT)) {
        // If the element doesn't also contain a response mapping to the default
        AnnotationModel apiResponsesParent = element.getAnnotation(org.eclipse.microprofile.openapi.annotations.responses.APIResponses.class.getName());
        if (apiResponsesParent != null) {
            List<AnnotationModel> apiResponses = apiResponsesParent.getValue("value", List.class);
            if (apiResponses.stream().map(a -> a.getValue("responseCode", String.class)).noneMatch(code -> code == null || code.isEmpty() || code.equals(APIResponses.DEFAULT))) {
                // Then remove the default response
                workingOperation.getResponses().removeAPIResponse(APIResponses.DEFAULT);
            }
        } else {
            workingOperation.getResponses().removeAPIResponse(APIResponses.DEFAULT);
        }
    }
}

Example 7 with APIResponseImpl

use of fish.payara.microprofile.openapi.impl.model.responses.APIResponseImpl in project Payara by payara.

the class ComponentsImpl method createInstance.

public static Components createInstance(AnnotationModel annotation, ApiContext context) {
    Components from = new ComponentsImpl();
    extractAnnotations(annotation, context, "schemas", "name", SchemaImpl::createInstance, from::addSchema);
    extractAnnotations(annotation, context, "responses", "name", APIResponseImpl::createInstance, from::addResponse);
    extractAnnotations(annotation, context, "parameters", "name", ParameterImpl::createInstance, from::addParameter);
    extractAnnotations(annotation, context, "examples", "name", ExampleImpl::createInstance, from::addExample);
    extractAnnotations(annotation, context, "requestBodies", "name", RequestBodyImpl::createInstance, from::addRequestBody);
    extractAnnotations(annotation, context, "securitySchemes", "securitySchemeName", SecuritySchemeImpl::createInstance, from::addSecurityScheme);
    extractAnnotations(annotation, context, "links", "name", LinkImpl::createInstance, from::addLink);
    extractAnnotations(annotation, context, "callbacks", "name", CallbackImpl::createInstance, from::addCallback);
    HeaderImpl.createInstances(annotation, context).forEach(from::addHeader);
    return from;
}

Example 8 with APIResponseImpl

use of fish.payara.microprofile.openapi.impl.model.responses.APIResponseImpl in project Payara by payara.

the class ModelInvariantsTest method addKeyValueIgnoresNull.

@Test
public void addKeyValueIgnoresNull() {
    BiPredicate<Extensible<?>, String> hasExtension = (obj, key) -> obj.getExtensions().containsKey(key);
    assertAddIgnoresNull(new CallbackImpl(), Callback::addPathItem, Callback::hasPathItem);
    assertAddIgnoresNull(new CallbackImpl(), Callback::addExtension, hasExtension);
    assertAddIgnoresNull(new ExampleImpl(), Example::addExtension, hasExtension);
    assertAddIgnoresNull(new HeaderImpl(), Header::addExample, (obj, key) -> obj.getExamples().containsKey(key));
    assertAddIgnoresNull(new HeaderImpl(), Header::addExtension, hasExtension);
    assertAddIgnoresNull(new ContactImpl(), Contact::addExtension, hasExtension);
    assertAddIgnoresNull(new InfoImpl(), Info::addExtension, hasExtension);
    assertAddIgnoresNull(new LicenseImpl(), License::addExtension, hasExtension);
    assertAddIgnoresNull(new LinkImpl(), Link::addParameter, (obj, key) -> obj.getParameters().containsKey(key));
    assertAddIgnoresNull(new LinkImpl(), Link::addExtension, hasExtension);
    assertAddIgnoresNull(new ContentImpl(), Content::addMediaType, Content::hasMediaType);
    assertAddIgnoresNull(new DiscriminatorImpl(), Discriminator::addMapping, (obj, key) -> obj.getMapping().containsKey(key));
    assertAddIgnoresNull(new EncodingImpl(), Encoding::addHeader, (obj, key) -> obj.getHeaders().containsKey(key));
    assertAddIgnoresNull(new EncodingImpl(), Encoding::addExtension, hasExtension);
    assertAddIgnoresNull(new MediaTypeImpl(), MediaType::addEncoding, (obj, key) -> obj.getEncoding().containsKey(key));
    assertAddIgnoresNull(new MediaTypeImpl(), MediaType::addExample, (obj, key) -> obj.getExamples().containsKey(key));
    assertAddIgnoresNull(new MediaTypeImpl(), MediaType::addExtension, hasExtension);
    assertAddIgnoresNull(new SchemaImpl(), Schema::addProperty, (obj, key) -> obj.getProperties().containsKey(key));
    assertAddIgnoresNull(new SchemaImpl(), Schema::addExtension, hasExtension);
    assertAddIgnoresNull(new XMLImpl(), XML::addExtension, hasExtension);
    assertAddIgnoresNull(new ParameterImpl(), Parameter::addExample, (obj, key) -> obj.getExamples().containsKey(key));
    assertAddIgnoresNull(new ParameterImpl(), Parameter::addExtension, hasExtension);
    assertAddIgnoresNull(new RequestBodyImpl(), RequestBody::addExtension, hasExtension);
    assertAddIgnoresNull(new APIResponseImpl(), APIResponse::addHeader, (obj, key) -> obj.getHeaders().containsKey(key));
    assertAddIgnoresNull(new APIResponseImpl(), APIResponse::addLink, (obj, key) -> obj.getLinks().containsKey(key));
    assertAddIgnoresNull(new APIResponseImpl(), APIResponse::addExtension, hasExtension);
    assertAddIgnoresNull(new APIResponsesImpl(), APIResponses::addAPIResponse, APIResponses::hasAPIResponse);
    assertAddIgnoresNull(new APIResponsesImpl(), APIResponses::addExtension, hasExtension);
    assertAddIgnoresNull(new OAuthFlowImpl(), OAuthFlow::addExtension, hasExtension);
    assertAddIgnoresNull(new OAuthFlowsImpl(), OAuthFlows::addExtension, hasExtension);
    assertAddIgnoresNull(new SecuritySchemeImpl(), SecurityScheme::addExtension, hasExtension);
    assertAddIgnoresNull(new ServerImpl(), Server::addExtension, hasExtension);
    assertAddIgnoresNull(new ServerVariableImpl(), ServerVariable::addExtension, hasExtension);
    assertAddIgnoresNull(new TagImpl(), Tag::addExtension, hasExtension);
    assertAddIgnoresNull(new ComponentsImpl(), Components::addCallback, (obj, key) -> obj.getCallbacks().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addExample, (obj, key) -> obj.getExamples().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addHeader, (obj, key) -> obj.getHeaders().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addLink, (obj, key) -> obj.getLinks().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addParameter, (obj, key) -> obj.getParameters().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addRequestBody, (obj, key) -> obj.getRequestBodies().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addResponse, (obj, key) -> obj.getResponses().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addSchema, (obj, key) -> obj.getSchemas().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addSecurityScheme, (obj, key) -> obj.getSecuritySchemes().containsKey(key));
    assertAddIgnoresNull(new ComponentsImpl(), Components::addExtension, hasExtension);
    assertAddIgnoresNull(new ExternalDocumentationImpl(), ExternalDocumentation::addExtension, hasExtension);
    assertAddIgnoresNull(new OpenAPIImpl(), OpenAPI::addExtension, hasExtension);
    assertAddIgnoresNull(new OperationImpl(), Operation::addCallback, (obj, key) -> obj.getCallbacks().containsKey(key));
    assertAddIgnoresNull(new OperationImpl(), Operation::addExtension, hasExtension);
    assertAddIgnoresNull(new PathItemImpl(), PathItem::addExtension, hasExtension);
    assertAddIgnoresNull(new PathsImpl(), Paths::addPathItem, Paths::hasPathItem);
    assertAddIgnoresNull(new PathsImpl(), Paths::addExtension, hasExtension);
}

Example 9 with APIResponseImpl

use of fish.payara.microprofile.openapi.impl.model.responses.APIResponseImpl in project Payara by payara.

the class ResponseTest method defaultDeleteStringSchemaTest.

@Test
public void defaultDeleteStringSchemaTest() {
    APIResponses responses = getDocument().getPaths().getPathItem("/test/response/schema").getDELETE().getResponses();
    checkResponseCode(responses, 200);
    final APIResponseImpl response = (APIResponseImpl) responses.getAPIResponse("200");
    checkMediaTypesExist(response, APPLICATION_JSON, APPLICATION_XML);
    checkSchemaDescriptions(response, "Custom Response");
}

Example 10 with APIResponseImpl

use of fish.payara.microprofile.openapi.impl.model.responses.APIResponseImpl in project Payara by payara.

the class ResponseTest method checkResponseCode.

private static void checkResponseCode(APIResponses responses, int responseCode, String description) {
    final APIResponseImpl response = (APIResponseImpl) responses.getAPIResponse(Integer.toString(responseCode));
    assertNotNull("The " + responseCode + " response should have been created.", response);
    assertEquals("The " + responseCode + " response has the wrong description", description, response.getDescription());
    // Test the default response doesn't exist
    assertNull("The default response should be removed when not used.", responses.getDefaultValue());
}