Hey Robert,

I did not heard from you, but I would not like you to wait for answer.

I once again investigated the definition. It actually is lacking a description of the response for the Employees endpoint (possibly for other endpoints too):

The yellow part is a good description inlcluding the content object with description and a reference to the schema of the expected response, which would be smth in the lines of:



I see there is an "Employee" schema in your definiton, so maybe this is what describes the Employees endpoint. Try to edit your definition and replace lines 65-70 with the following:

"responses": {
  "200": {
	"description": "Success",
	"content": {
	  "application/json": {
		"schema": {
		  "type": "array",
		  "items": {
			"$ref": "#/components/schemas/Employee"
		  }
		}
	  }
	}
  }
}

Hi thanks for the reply Pablo. I will just point out that my current code using Results.OK does work fine with Swagger,and with other projects that call the REST endpoints. I get back proper return codes 200, 404 etc. and Json data and the schema shows in Swagger too.

The documentation link you referred me to states. "Minimal endpoints support the following types of return values:"

1. string - This includes Task<string> and ValueTask<string>.
2. T (Any other type) - This includes Task<T> and ValueTask<T>.
3. IResult based - This includes Task<IResult> and ValueTask<IResult>.

So I would have expected AppBuilder should support Task<IResult> as I think that is where the issue is. Even if I change the return Results.OK(...) to return TypedResults.OK(...) app builder stays greyed out I suspect because the PersonGetAll() function returns a Task<IResult>.

My C# knowledge is far from complete as mentioned above. Any ideas how I can refactor those calls as all my many endpoints work in this manner. Thanks.

Anthony,

It's not about App Builder supporting IResult, it's about feeding Swagger with information to properly describe the response type.

e.g.

When using IResult with no additional information this area will be empty.

Anthony Marler said:

Even if I change the return Results.OK(...) to return TypedResults.OK(...) app builder stays greyed out I suspect because the PersonGetAll() function returns a Task<IResult>

If you only return OK results, then change it to Task<Ok<YourResponseType>> like in the docs:

public static async Task<Ok<Todo[]>> GetAllTodos(TodoGroupDbContext database)
{
    var todos = await database.Todos.ToArrayAsync();
    return TypedResults.Ok(todos);
}

If you need to keep IResult, then you need to add a .Produces<>() statement:

Consider the following endpoint, for which a 400 BadRequest status code is returned when the orderId is greater than 999. Otherwise, it produces a 200 OK with the expected content.
C#

app.MapGet("/orders/{orderId}", IResult (int orderId)
    => orderId > 999 ? TypedResults.BadRequest() : TypedResults.Ok(new Order(orderId)))
    .Produces(400)
    .Produces<Order>();

I hope this helps.

Thanks for continuing to help me. Getting there now. Here is the code and I am now returning a PersonModel using Produces statement.

This still works with Swagger

And in AppBuilder almost but...

Then I can't bind to the grid as now options sow against the source. "This resource contains a single object" indicates my Produces isn't right I guess?

Anthony

PS. It's early hours of the morning here so I'll pick this up tomorrow. Thanks again.

Anthony Marler said:

This resource contains a single object" indicates my Produces isn't right I guess?

Yes, since you're trying to return a collection, your type should describe some type of collection or enumerable.

e.g. .Produces<IEnumerable<PersonModel>>()

Haha. Glad to have helped you.

Cheers

Bingo!! It works!! Pablo if we should ever meet I owe you an obscene amount of alcohol!! In the meantime, please accept my sincere thanks at spending the time to walk me through this with my, still limited, knowledge of C#. Having this problem, and then your advice has actually taught me a lot. Many thanks.

Anthony