AutoQuery , Skip , Take and Swagger

ServiceStack Auto Query
1

Hi, it seems that the SKip And Take parameters are reported as being of type Form in the metadata page … and they do not show up in the Swagger UI.

I succesfully workaround the problem writing this
typeof(QueryBase).GetProperty(“Skip”).AddAttributes(new ApiMemberAttribute {IsRequired = false, ParameterType = “Query”, DataType = “integer” });

typeof(QueryBase).GetProperty(“Take”).AddAttributes(new ApiMemberAttribute { IsRequired = false, ParameterType = “Query”, DataType = “integer” });

However I think this attributes should be defined “out of the box” in the QueryBase class

2

it’s actually
ParameterType = “query” (lowercase)

btw , the same applies to OrderBy and OrderByDesc

3

I’m seeing them reported as query:

Pasted image1452×1188 113 KB

Are you looking at the GET operation?

4

it works as long in my input dto I do not put any apimemember attribute …
when I do it , swagger breaks …

with this DTO :
public class FindPersonsBindings : QueryDb
{
[DataMember(Name = “applicationId”)]
public int ApplicationId { get; set; }
[DataMember(Name = “projectId”)]
public int ProjectId { get; set; }
[DataMember(Name = “personId”)]
public List PersonId { get; set; }
[DataMember(Name = “surnameStartsWith”)]
public string SurnameStartsWith { get; set; }
[DataMember(Name = “firstNameStartsWith”)]
public string FirstNameStartsWith { get; set; }
[DataMember(Name = “defaultOrganisationNameStartsWith”)]
public string DefaultOrganisationNameStartsWith { get; set; }
[DataMember(Name = “abbreviation”)]
public string Abbreviation { get; set; }
[DataMember(Name = “userName”)]
public string UserName { get; set; }

}
IT DOES WORK

Pasted image1019×476 52.6 KB

If I add Apimember attribute to 3 properties

public class FindPersonsBindings : QueryDb
{
[DataMember(Name = “applicationId”)]
[ApiMember(IsRequired = true, ParameterType = “path”, DataType = “integer”)]
public int ApplicationId { get; set; }
[DataMember(Name = “projectId”)]
[ApiMember(IsRequired = true, ParameterType = “path”, DataType = “integer”)]
public int ProjectId { get; set; }

[DataMember(Name = "personId")]
**[ApiMember(ParameterType = "query", DataType = "integer",Description = "more than one personId can be specified, repeating the querystring parameter. e.g.: ..&personId=1&personId=2")]**
public List<int> PersonId { get; set; } 
[DataMember(Name = "surnameStartsWith")]

public string SurnameStartsWith { get; set; }
[DataMember(Name = "firstNameStartsWith")]

public string FirstNameStartsWith { get; set; }
[DataMember(Name = "defaultOrganisationNameStartsWith")]

public string DefaultOrganisationNameStartsWith { get; set; }
[DataMember(Name = "abbreviation")]

public string Abbreviation { get; set; }
[DataMember(Name = "userName")]

public string UserName { get; set; }

}

all the properties without the ApiMemeber attribute disappear from the browser:

Pasted image938×222 32.6 KB

5

Right, as soon as you use a [ApiMember] on your Request DTO the behavior becomes opt-in same as DataContract/DataMember attributes, this is by design.

6

I don’t think an opt-in behaviour is a good idea for ApiMember attribute …

Say I have a dto with 25 properties … If I need to add a description to one of them (using ApiMember) … I’ll have to add that attribute to all of them…

7

You can use the [Description] attribute if you just want to add a description.

8

Adding ApiMember (for example to specify that an input field is required) hides all the AutoQuery parameters, as you described. Because those properties are not in my custom DTO, I can’t even add an ApiMember attribute to them to bring them back. How can use ApiMember but not lose the skip/take etc. params?

9

In current design adding [ApiMember] hides all other non-annotated by [ApiMember] properties. Like [DataMember] in serialization. And the only way to make them visible or use plugin filters or by dynamically add [ApiMember] attribute to remaining properties. Alternative way could be an adding option to Swagger/OpenApi plugin configuration, which changes the behavior of hiding non-annotated members, but this change in design need to be approved by @mythz first

10

I understand the behavior - however in this case, because there are properties on a AutoQuery object that we don’t control, we cannot add ApiMember to them to opt them in. You understand the problem?

11

As I said in previous post [ApiMember] attributes can be added dynamically to any types during program execution. One note that these attributes have to be added before AppHost.Init(), so you can add them in constructor

You can look at example here

12

I think that the current behaviour is not a good idea … properties without apimember should fall back to an “autonomous” fallback behaviour.

BTW : when I moved to openapi … I had all autoquerybase object properties set to parameter type “form” even if there was no apimember on the input dto
so I add to write this

public override void Configure(Container container)
{
    base.Configure(container);
    Plugins.Add(new AutoQueryFeature { MaxLimit = 100, EnableUntypedQueries = true });
    typeof(QueryBase).GetProperty("Skip").AddAttributes(new ApiMemberAttribute { IsRequired = false, ParameterType = "query", DataType = "integer" });
    typeof(QueryBase).GetProperty("Take").AddAttributes(new ApiMemberAttribute { IsRequired = false, ParameterType = "query", DataType = "integer" });
    typeof(QueryBase).GetProperty("OrderBy").AddAttributes(new ApiMemberAttribute { IsRequired = false, ParameterType = "query", DataType = "integer" });
    typeof(QueryBase).GetProperty("OrderByDesc").AddAttributes(new ApiMemberAttribute { IsRequired = false, ParameterType = "query", DataType = "integer" });
    typeof(QueryBase).GetProperty("Include").AddAttributes(new ApiMemberAttribute { IsRequired = false, ParameterType = "query", DataType = "integer" });
    typeof(QueryBase).GetProperty("Fields").AddAttributes(new ApiMemberAttribute { IsRequired = false, ParameterType = "query", DataType = "integer" });
}

… would you check that ?
tjhank you
enrico