public class Oas30Header extends OasHeader implements IReferenceNode
Modifier and Type | Field and Description |
---|---|
String |
$ref |
Boolean |
allowEmptyValue |
Boolean |
allowReserved |
Map<String,Oas30MediaType> |
content |
Boolean |
deprecated |
Object |
example |
Map<String,Oas30Example> |
examples |
Boolean |
explode |
Boolean |
required |
Oas30Schema |
schema |
String |
style |
description
_extensions
_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems
Constructor and Description |
---|
Oas30Header(String name)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addExample(Oas30Example example)
Adds the Example to the map of examples.
|
void |
addMediaType(String name,
Oas30MediaType mediaType)
Adds a media type.
|
Oas30Example |
createExample(String name)
Creates a child Example model.
|
Oas30MediaType |
createMediaType(String name)
Creates a media type.
|
Oas30Schema |
createSchema()
Creates a child items model.
|
Oas30Example |
getExample(String name)
Gets a single example by name.
|
List<Oas30Example> |
getExamples()
Gets all examples.
|
Oas30MediaType |
getMediaType(String name)
Gets a single media type by name.
|
List<Oas30MediaType> |
getMediaTypes()
Gets a list of all media types.
|
Oas30Example |
removeExample(String name)
Removes an Example and returns it.
|
Oas30MediaType |
removeMediaType(String name)
Removes a single media type and returns it.
|
accept, getName, rename
addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension
addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute
public String $ref
public Boolean required
public Boolean deprecated
public Boolean allowEmptyValue
public String style
public Boolean explode
public Boolean allowReserved
public Oas30Schema schema
public Object example
public Map<String,Oas30Example> examples
public Map<String,Oas30MediaType> content
public Oas30Header(String name)
public Oas30Schema createSchema()
public Oas30Example createExample(String name)
public void addExample(Oas30Example example)
example
- public Oas30Example removeExample(String name)
name
- public Oas30Example getExample(String name)
name
- public List<Oas30Example> getExamples()
public Oas30MediaType createMediaType(String name)
name
- public void addMediaType(String name, Oas30MediaType mediaType)
name
- mediaType
- public Oas30MediaType getMediaType(String name)
name
- public Oas30MediaType removeMediaType(String name)
name
- public List<Oas30MediaType> getMediaTypes()
Copyright © 2019 Red Hat. All rights reserved.