How to limit Depth in Swagger

BIZ TMS XData
1

Is it possible to limit the nesting depth of entity classes for the Swagger documentation, similar to how the AureliusDataset does it with the Depth parameter?

for example:

TChild3 = class
 ...
end;

TChild2 = class
 FChild = TChild3;
end;

TChild = class
 FChild = TChild2;
end;

TEntity = class
 FChild: TChild;
end;

Showing TEntity in swagger should only come up with definition of TChild, but not expand (or even build) definition of TChild2

Entity { 
  Child { 
    Child{}
  }
}

It looks like, this is working, if there are recursions within entities (for example TChild would have an ManyValueAssoc of TEntity). But is this something, we could easily activate?

2

You could add [SwaggerExclude] to the child entities.

3

But this would exclude these for all references in swagger.

if you are looking at the definition of this entity I'd like to see these relations.
But I would like to hide these relations, if this entity is already shown by a relation.

4

No, that is not possible.

I didn't understand what you meant here.

5

When a class references itself, Swagger seems to detect this already and does not list it again in the definition.

TChild = class
 FId: Integer;
 FAnotherChild = TChild;
end;

TEntity = class
 FId: Integer;
 FChild: TChild;
end;

Entity { 
  Id: integer,
  Child { 
    Id: integer,
    AnotherChild{}
  }
}

Hope, this clarifies.

6

I really don't know exactly what the issue is and what you want to achieve.
Maybe you have a sample project with the mentioned classes and a XData server generating the Swagger and please let me know what exactly is wrong with it?

7

There is no error at all.
Having classes referencing themselves, for example storing trees, it looks like, there is something that will stop swagger showing up classes that are to deep.

Maybe there is some attribute like XDataExcludePropertyAttribute, that would prevent swagger from expanding the sub class of this field / property.
That was my only question.

8

There isn't such attribute. I believe the Swagger UI JavaScript interface automatically detects cycles to avoid infinite loops, but it's out of our control. Other than this, it will show the whole tree.

9

This topic was automatically closed 24 hours after the last reply. New replies are no longer allowed.