Change/Configurat DataSchema in Documentation

[meep334]

We use Schema Composition to define relationships for our models. In the API Responses tab the Data Schema has a nice and clear overview of all properties (the composition is flattened), but in the documentation tab when <DataSchema id="xxxxx" /> is used, the preview is not flattened.

Are there any attributes which can change this preview? I found the JSON Viewer Package package, and see there is a lot of customizability. Maybe some of these attributes can be forwarded?

Other than the preview being flattened; I’d love to see the attribute viewMode="read|write|standalone" to choose between hiding or showing the readOnly properties. This can be useful when documenting the request or response of an endpoint.

[came7o (melo)]

1.I didn’t understand how you used it, please take a screenshot
2. You can choose read only or write only here

[meep334]

In documentation the data schema looks like the first image (schema composition shows as objects), but on the response page it looks like the second image (flattened). I want DataSchema in the documentation to look the same as the preview in the responses tab

[momota0908 (Alan)]

Sorry, I didn’t understand your question. It would be helpful if you could provide your steps and screenshots.

[meep334]

A very minimal example;

1. I have a CompositionSchema with type allOf. This has two objects.

• One object containing an id
• The other containing the description field

2. I have an endpoint which uses this schema as a ref in the response.

• I have published my project to https://8qi18fnjhe.eu.apidog.com
• In the response the schema looks like a normal object with only id and description.

3. In the endpoint documentation I use <DataSchema id="374357" />

• I open the published project and see the whole composition schema, instead of only id and description
• See second to last image

I want the DataSchema to look the same as how it looks in Response; see last image

[momota0908 (Alan)]

Thanks for the feedback, we will think about how to optimize it.

[meep334]

Thanks for your time! Sorry for the ambiguity

[meep334]

In documentation the data schema looks like the first image (schema composition shows as objects), but on the response page it looks like the second image (flattened). I want DataSchema in the documentation to look the same as the preview in the responses tab

[meep334]

A very minimal example;

1. I have a CompositionSchema with type allOf. This has two objects.

• One object containing an id
• The other containing the description field

2. I have an endpoint which uses this schema as a ref in the response.

• I have published my project to https://8qi18fnjhe.eu.apidog.com
• In the response the schema looks like a normal object with only id and description.

3. In the endpoint documentation I use <DataSchema id="374357" />

• I open the published project and see the whole composition schema, instead of only id and description
• See second to last image

I want the DataSchema to look the same as how it looks in Response; see last image

[meep334]

Thanks for your time! Sorry for the ambiguity