Load a sample schema
JSON definition · shared/definitions/creator-load-save.json
View on GitHub
{
"title": "Support request",
"elements": [
{
"type": "dropdown",
"name": "product",
"title": "Product",
"choices": [
"Form Library",
"Survey Creator",
"Dashboard",
"PDF Generator"
]
},
{
"type": "comment",
"name": "issue",
"title": "Describe the issue",
"isRequired": true
},
{
"type": "radiogroup",
"name": "urgency",
"title": "How urgent is it?",
"choices": [
"Low",
"Normal",
"Blocking"
]
},
{
"type": "boolean",
"name": "callback",
"title": "Call me back"
}
]
}
Client · shared/client/lint-definition.js · sjs:lint-definition.client
View on GitHub
// Display the server's errors and warnings and return the actual save result to Creator
async function saveDefinition(definition) {
const response = await fetch(`/api/forms/${formId}`, {
method: "PUT", headers: { "Content-Type": "application/json" }, body: JSON.stringify(definition)
});
const report = response.status === 204 ? {} : await response.json();
reportFindings(report);
if (response.status === 422 && Array.isArray(report.errors) && report.errors.length) {
note("Form schema not saved. Fix the reported errors and retry.", "error");
return false;
}
if (!response.ok) throw new Error(report.error || "Couldn't save the form schema. Please try again.");
const count = report.warnings?.length ?? 0;
note(count ? `Schema saved with ${count} warning${count === 1 ? "" : "s"}. Review the findings above.` : "Form schema saved successfully.", "ok");
return true;
}
creator.saveSurveyFunc = async (saveNo, callback) => callback(saveNo, await checkAndSave(creator.JSON));
Server · src/main/java/io/surveyjs/examples/LintDefinitionController.java · sjs:lint-definition.server
View on GitHub
// PUT /api/forms/{id} — lint the definition from Creator before storing it
@PutMapping("/api/forms/{id}")
@PreAuthorize("hasAuthority('edit-forms')")
public ResponseEntity<JsonNode> saveLintedForm(@PathVariable String id, @RequestBody JsonNode definition) {
// A JsonNode keeps {} as {} (see Load and Save Form JSON Schemas)
ServiceAnswer lint = surveyjs.post("/schema", definition, Duration.ofSeconds(10));
JsonNode answer = lint.json(); // null when it isn't JSON: fails closed below
if (lint.status() == 422 && answer != null && answer.has("errors") && answer.has("warnings")) {
return ResponseEntity.status(HttpStatus.UNPROCESSABLE_CONTENT).body(answer); // errors: refuse the save, report them as they are
}
boolean clean = lint.status() == 200 && answer instanceof ObjectNode found && found.isEmpty();
boolean warningsOnly = lint.status() == 200 && answer instanceof ObjectNode found && found.size() == 1 && found.has("warnings");
if (!clean && !warningsOnly) { // fail closed: nothing else is a lint result
throw surveyjs.unexpected("/schema", lint);
}
storedJson.put("forms", id, definition); // stored as it arrived: 1.0 stays 1.0
return warningsOnly ? ResponseEntity.ok(answer) : ResponseEntity.noContent().build(); // warnings don't block it
}