Required properties in Swagger Output

BIZ TMS XData
1

We have written an XData server with a Service that doesn't use a database, so no Aurelius entities are defined.

We have classes defined which are inputs to functions on the Service, and others that are outputs.

The problem we are trying to solve is that when the Swagger is imported in C# (using Newtonsoft) the objects are defined but aren't created. So, the imported Swagger looks like this (partial)

Current XData Swagger : public partial class TCreateLabelRequest 
[Newtonsoft.Json.JsonProperty("shipFrom", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] 
        public TGFSAddress ShipFrom { get; set; }
    
        [Newtonsoft.Json.JsonProperty("shipTo", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
        public TGFSAddress ShipTo { get; set; }

However, when we import from another Swagger (written in Node.js) we get the following:

Current Node Swagger : public partial class CreateLabelRequest
[Newtonsoft.Json.JsonProperty("shipFrom", Required = Newtonsoft.Json.Required.Always)] 
        [System.ComponentModel.DataAnnotations.Required]
        public Address ShipFrom { get; set; } = new Address();

        [Newtonsoft.Json.JsonProperty("shipTo", Required = Newtonsoft.Json.Required.Always)]
        [System.ComponentModel.DataAnnotations.Required]
        public Address ShipTo { get; set; } = new Address();

Note that the definitions have new Address() appended. This seems to be the result of the required flag being set to Always (Required = Newtonsoft.Json.Required.Always) rather than Default (Required = Newtonsoft.Json.Required.Default).

Is there a way to set this in XData on the class definition? Or is there another way this could be acheived?

Thanks

2

Here is part of the json from the swaggers:

Node Swagger:
"definitions": { 
    "CreateLabelRequest": {
      "type": "object",
      "required": [
        "serviceProvider",
        "labelSpecification",
        "consignment",
        "packages",
        "shipFrom",
        "shipTo",
        "serviceType"
      ],
      "properties": {

XData Swagger
"definitions": { 
    "GFSProxyDtos.TCreateLabelRequest": {
      "type": "object",
      "properties": {
3

All sorted, found what I was looking for on Other Tasks | TMS XData documentation (tmssoftware.com)

1 Like
4

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