Package | Description |
---|---|
org.eclipse.microprofile.openapi |
A set of Java interfaces, annotations and programming models
which allow Java developers to natively produce OpenAPI v3 documents
from their JAX-RS applications.
|
org.eclipse.microprofile.openapi.models.info |
A set of interfaces of programmable models to represent metadata about the API,
including license information and contact information of the exposed API.
|
Modifier and Type | Method and Description |
---|---|
static Contact |
OASFactory.createContact()
This method creates a new
Contact instance. |
Modifier and Type | Method and Description |
---|---|
default Contact |
Contact.email(String email)
Sets this Contact instance's contact email to the given email and returns this instance of Contact
|
Contact |
Info.getContact()
Returns the contact information for the exposed API from this Info instance.
|
default Contact |
Contact.name(String name)
Sets this Contact instance's identifying name to the given name and returns this instance of Contact.
|
default Contact |
Contact.url(String url)
Sets this Contact instance's URL pointing to the contact information and returns this instance of Contact.
|
Modifier and Type | Method and Description |
---|---|
default Info |
Info.contact(Contact contact)
Sets this Info instance's contact information for the exposed API and returns this instance of Info.
|
void |
Info.setContact(Contact contact)
Sets this Info instance's contact information for the exposed API.
|
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.