void updateObjectModel(
final ModelImpl model,
final ObjectSpecification objectSpecification,
final List<OneToOneAssociation> objectProperties,
final List<OneToManyAssociation> objectCollections) {
final String objectType = objectTypeFor(objectSpecification);
final String className = objectSpecification.getFullIdentifier();
model.type("object").description(String.format("%s (%s)", objectType, className));
for (OneToOneAssociation objectProperty : objectProperties) {
model.property(objectProperty.getId(), propertyFor(objectProperty.getSpecification()));
}
for (OneToManyAssociation objectCollection : objectCollections) {
final ObjectSpecification elementSpec = objectCollection.getSpecification();
model.property(objectCollection.getId(), arrayPropertyOf(elementSpec));
}
}
void appendServiceActionInvokePath(
final ObjectSpecification serviceSpec, final ObjectAction serviceAction) {
final String serviceId = serviceIdFor(serviceSpec);
final String actionId = serviceAction.getId();
final List<ObjectActionParameter> parameters = serviceAction.getParameters();
final Path path = new Path();
swagger.path(String.format("/services/%s/actions/%s/invoke", serviceId, actionId), path);
final String tag = tagFor(serviceId, "> services");
final Operation invokeOperation =
new Operation()
.tag(tag)
.description(
Util.roSpec("19.1") + ": (invoke) resource of " + serviceId + "#" + actionId)
.produces("application/json;profile=urn:org.apache.isis/v1")
.produces("application/json;profile=urn:org.apache.isis/v1;suppress=true")
.produces("application/json;profile=urn:org.restfulobjects:repr-types/action-result");
final ActionSemantics.Of semantics = serviceAction.getSemantics();
if (semantics.isSafeInNature()) {
path.get(invokeOperation);
for (final ObjectActionParameter parameter : parameters) {
invokeOperation.parameter(
new QueryParameter()
.name(parameter.getId())
.description(
Util.roSpec("2.9.1")
+ (!Strings.isNullOrEmpty(parameter.getDescription())
? (": " + parameter.getDescription())
: ""))
.required(false)
.type("string"));
}
if (!parameters.isEmpty()) {
invokeOperation.parameter(
new QueryParameter()
.name("x-isis-querystring")
.description(
Util.roSpec("2.10") + ": all (formal) arguments as base64 encoded string")
.required(false)
.type("string"));
}
} else {
if (semantics.isIdempotentInNature()) {
path.put(invokeOperation);
} else {
path.post(invokeOperation);
}
final ModelImpl bodyParam = new ModelImpl().type("object");
for (final ObjectActionParameter parameter : parameters) {
final Property valueProperty;
// TODO: need to switch on parameter's type and create appropriate impl of valueProperty
// if(parameter.getSpecification().isValue()) ...
valueProperty = stringProperty();
bodyParam.property(
parameter.getId(), new ObjectProperty().property("value", valueProperty));
}
invokeOperation
.consumes("application/json")
.parameter(new BodyParameter().name("body").schema(bodyParam));
}
invokeOperation.response(
200,
new Response()
.description(
serviceId
+ "#"
+ actionId
+ " , if Accept: application/json;profile=urn:org.apache.isis/v1")
.schema(actionReturnTypeFor(serviceAction)));
}
void appendObjectActionInvokePath(
final ObjectSpecification objectSpec, final ObjectAction objectAction) {
final String objectType = objectTypeFor(objectSpec);
final String actionId = objectAction.getId();
final List<ObjectActionParameter> parameters = objectAction.getParameters();
final Path path = new Path();
swagger.path(
String.format("/objects/%s/{objectId}/actions/%s/invoke", objectType, actionId), path);
final String tag = tagFor(objectType, null);
final Operation invokeOperation =
new Operation()
.tag(tag)
.description(
Util.roSpec("19.1") + ": (invoke) resource of " + objectType + "#" + actionId)
.parameter(new PathParameter().name("objectId").type("string"))
.produces("application/json;profile=urn:org.apache.isis/v1")
.produces("application/json;profile=urn:org.apache.isis/v1;suppress=true")
.produces("application/json;profile=urn:org.restfulobjects:repr-types/action-result");
final ActionSemantics.Of semantics = objectAction.getSemantics();
if (semantics.isSafeInNature()) {
path.get(invokeOperation);
for (final ObjectActionParameter parameter : parameters) {
invokeOperation.parameter(
new QueryParameter()
.name(parameter.getId())
.description(
Util.roSpec("2.9.1")
+ (!Strings.isNullOrEmpty(parameter.getDescription())
? (": " + parameter.getDescription())
: ""))
.required(false)
.type("string"));
}
if (!parameters.isEmpty()) {
invokeOperation.parameter(
new QueryParameter()
.name("x-isis-querystring")
.description(
Util.roSpec("2.10") + ": all (formal) arguments as base64 encoded string")
.required(false)
.type("string"));
}
} else {
if (semantics.isIdempotentInNature()) {
path.put(invokeOperation);
} else {
path.post(invokeOperation);
}
final ModelImpl bodyParam = new ModelImpl().type("object");
for (final ObjectActionParameter parameter : parameters) {
final ObjectSpecification specification = parameter.getSpecification();
final Property valueProperty =
specification.isValue() ? modelFor(specification) : refToLinkModel();
bodyParam.property(
parameter.getId(), new ObjectProperty().property("value", valueProperty));
}
invokeOperation
.consumes("application/json")
.parameter(new BodyParameter().name("body").schema(bodyParam));
}
invokeOperation.response(
200,
new Response()
.description(objectType + "#" + actionId)
.schema(actionReturnTypeFor(objectAction)));
}
public Model definition(ObjectNode node, String location, ParseResult result) {
if (node == null) {
result.missing(location, "empty schema");
}
if (node.get("$ref") != null) {
return refModel(node, location, result);
}
if (node.get("allOf") != null) {
return allOfModel(node, location, result);
}
Model model = null;
String value = null;
String type = getString("type", node, false, location, result);
Model m = new ModelImpl();
if ("array".equals(type)) {
ArrayModel am = new ArrayModel();
ObjectNode propertyNode = getObject("properties", node, false, location, result);
Map<String, Property> properties = properties(propertyNode, location, result);
am.setProperties(properties);
ObjectNode itemsNode = getObject("items", node, false, location, result);
Property items = property(itemsNode, location, result);
if (items != null) {
am.items(items);
}
model = am;
} else {
ModelImpl impl = new ModelImpl();
impl.setType(value);
JsonNode ap = node.get("additionalProperties");
if (ap != null && ap.getNodeType().equals(JsonNodeType.OBJECT)) {
impl.setAdditionalProperties(Json.mapper().convertValue(ap, Property.class));
}
value = getString("default", node, false, location, result);
impl.setDefaultValue(value);
value = getString("format", node, false, location, result);
impl.setFormat(value);
value = getString("discriminator", node, false, location, result);
impl.setDiscriminator(value);
JsonNode xml = node.get("xml");
if (xml != null) {
impl.setXml(Json.mapper().convertValue(xml, Xml.class));
}
ObjectNode externalDocs = getObject("externalDocs", node, false, location, result);
ExternalDocs docs = externalDocs(externalDocs, location, result);
impl.setExternalDocs(docs);
ObjectNode properties = getObject("properties", node, true, location, result);
if (properties != null) {
Set<String> propertyNames = getKeys(properties);
for (String propertyName : propertyNames) {
JsonNode propertyNode = properties.get(propertyName);
if (propertyNode.getNodeType().equals(JsonNodeType.OBJECT)) {
ObjectNode on = (ObjectNode) propertyNode;
Property property = property(on, location, result);
impl.property(propertyName, property);
} else {
result.invalidType(location, "properties", "object", propertyNode);
}
}
}
// need to set properties first
ArrayNode required = getArray("required", node, false, location, result);
if (required != null) {
List<String> requiredProperties = new ArrayList<String>();
for (JsonNode n : required) {
if (n.getNodeType().equals(JsonNodeType.STRING)) {
requiredProperties.add(((TextNode) n).textValue());
} else {
result.invalidType(location, "required", "string", n);
}
}
if (requiredProperties.size() > 0) {
impl.setRequired(requiredProperties);
}
}
// extra keys
Set<String> keys = getKeys(node);
for (String key : keys) {
if (key.startsWith("x-")) {
impl.setVendorExtension(key, extension(node.get(key)));
} else if (!SCHEMA_KEYS.contains(key)) {
result.extra(location, key, node.get(key));
}
}
if ("{ }".equals(Json.pretty(impl))) return null;
model = impl;
}
JsonNode exampleNode = node.get("example");
if (exampleNode != null) {
// we support text or object nodes
if (exampleNode.getNodeType().equals(JsonNodeType.OBJECT)) {
ObjectNode on = getObject("example", node, false, location, result);
if (on != null) {
model.setExample(on);
}
} else {
model.setExample(exampleNode.asText());
}
}
if (model != null) {
value = getString("description", node, false, location, result);
model.setDescription(value);
value = getString("title", node, false, location, result);
model.setTitle(value);
}
return model;
}
