com.networknt.oas.model.Response Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation

A light-weight, fast OpenAPI 3.0 parser and validator

There is a newer version: 2.1.38

package com.networknt.oas.model;

import com.networknt.oas.jsonoverlay.Reference;

import java.util.Map;

public interface Response extends OpenApiObject {

    // Description

    String getDescription();


    String getDescription(boolean elaborate);


    void setDescription(String description);

    // Header

    Map getHeaders();


    Map getHeaders(boolean elaborate);


    boolean hasHeader(String name);


    Header getHeader(String name);


    void setHeaders(Map headers);


    void setHeader(String name, Header header);


    void removeHeader(String name);


    boolean isHeaderReference(String key);


    Reference getHeaderReference(String key);

    // ContentMediaType

    Map getContentMediaTypes();


    Map getContentMediaTypes(boolean elaborate);


    boolean hasContentMediaType(String name);


    MediaType getContentMediaType(String name);


    void setContentMediaTypes(Map contentMediaTypes);


    void setContentMediaType(String name, MediaType contentMediaType);


    void removeContentMediaType(String name);

    // Link

    Map getLinks();


    Map getLinks(boolean elaborate);


    boolean hasLink(String name);


    Link getLink(String name);


    void setLinks(Map links);


    void setLink(String name, Link link);


    void removeLink(String name);


    boolean isLinkReference(String key);


    Reference getLinkReference(String key);

    // Extension

    Map getExtensions();


    Map getExtensions(boolean elaborate);


    boolean hasExtension(String name);


    Object getExtension(String name);


    void setExtensions(Map extensions);


    void setExtension(String name, Object extension);


    void removeExtension(String name);

}