fix required attribute processing for json schema of oneOf #453
Conversation
|
@w-vi I am adding you as a reviewer too. |
src/refract/JSONSchemaVisitor.cc
Outdated
| JSONSchemaVisitor renderer(pDefs, fixed); | ||
| Visit(renderer, *(*it)); | ||
| ObjectElement *o1 = TypeQueryVisitor::as<ObjectElement>(renderer.get()); | ||
| if (!o1->value.empty()) { |
There was a problem hiding this comment.
Please add an empty line before this.
src/refract/JSONSchemaVisitor.cc
Outdated
| ObjectElement *o1 = TypeQueryVisitor::as<ObjectElement>(renderer.get()); | ||
| if (!o1->value.empty()) { | ||
| MemberElement *m1 = TypeQueryVisitor::as<MemberElement>(o1->value[0]->clone()); | ||
| if (m1) { |
There was a problem hiding this comment.
Please add an empty line before this.
src/refract/JSONSchemaVisitor.cc
Outdated
| m1->renderType(IElement::rCompact); | ||
| o->push_back(m1); | ||
| } | ||
|
|
src/refract/JSONSchemaVisitor.cc
Outdated
| switch (type.get()) { | ||
| case TypeQueryVisitor::Member: { | ||
| MemberElement *mr = static_cast<MemberElement*>(*it); | ||
| if (IsTypeAttribute(*(*it), "required") || |
There was a problem hiding this comment.
Please add an empty line before this.
src/refract/JSONSchemaVisitor.cc
Outdated
| ((fixed || fixedType) && !IsTypeAttribute(*(*it), "optional"))) { | ||
|
|
||
| StringElement *str = TypeQueryVisitor::as<StringElement>(mr->value.first); | ||
| if (str) { |
There was a problem hiding this comment.
Please add an empty line before this.
src/refract/JSONSchemaVisitor.cc
Outdated
|
|
||
| pObj = new ObjectElement; | ||
| pObj->renderType(IElement::rCompact); | ||
|
|
||
| addMember("properties", props); | ||
| if (!reqVals.empty()) { | ||
| addMember("required", new ArrayElement(reqVals, IElement::rCompact)); | ||
| } | ||
| if (!oneOfMembers.empty()) { |
There was a problem hiding this comment.
Please add an empty line before this.
src/refract/JSONSchemaVisitor.cc
Outdated
|
|
||
| pObj = new ObjectElement; | ||
| pObj->renderType(IElement::rCompact); | ||
|
|
||
| addMember("properties", props); | ||
| if (!reqVals.empty()) { |
There was a problem hiding this comment.
Please add an empty line before this.
| } | ||
| } | ||
| else { | ||
| Visit(*this, *(*it)); |
There was a problem hiding this comment.
This logic is missing in the refactor.
There was a problem hiding this comment.
There was a problem hiding this comment.
Ah, okay. Add another test case as I requested and I can merge this.
| - Properties | ||
| - foo: A (string, required) | ||
|
|
||
| - Properties |
There was a problem hiding this comment.
Try a test case with removing only the above line. Properties is not always needed.
There was a problem hiding this comment.
should I add one more test with such data
# GET /ab
- response 200 (application/json)
- Attributes (Test)
# Data Structures
## Test (object)
- One Of
- Properties
- foo: A (string, required)
- bar: B (string)
or change this one?
test/fixtures/oneof/required2.apib
Outdated
| - Properties | ||
| - foo: A (string, required) | ||
|
|
||
| - bar: B (string) |
There was a problem hiding this comment.
Please add required here.
|
@goganchic Can you force push and trigger the CI again please? Thanks. |
|
done |
|
Should've been squashed but otherwise it's all good. Cheers @goganchic |
|
Is it possible to include this fix in the next release? |
|
Will do. |
|
Thanks a lot, Pavan! Спасибо! |
This PR solves problem described in #452, but I think a bit of refactoring is required. It's possible to make it in separate PR or in this one.
Functions
void JSONSchemaVisitor::operator()(const OptionElement& e)andvoid JSONSchemaVisitor::operator()(const ObjectElement& e)have a lot of common code (MemberElement & SelectElement processing, required attributes calculation) and I think this code a bit dirty: it's difficult to understand Select -> Option -> Select chain processing. This refactoring may take some time and it's difficult to estimate how much time it will be.// UPDATE: refactoring complete