AppBuilder: When adding REST-api the endpoints are disabled and not selectable

Robert Deutschmann posted over 1 year ago

For a simple test project i created a REST-api with only some endpoints. But when adding this REST-api into AppBuilder the endpoints "Employees" are visible but not selectable - they are grey and looks disabled:

swagger-definition:

swagger_def.txt

{
openapi: "3.0.1",
info: {
title: "FullStack.API",
version: "1.0"
},
paths: {
/api/Employees: {
get: {
tags: [
"Employees"
],
responses: {
200: {
description: "Success"
}
}
},
post: {
tags: [
"Employees"
],
requestBody: {
content: {
application/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
text/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
application/*+json: {
schema: {
$ref: "#/components/schemas/Employee"
}
}
}
},
responses: {
200: {
description: "Success"
}
}
}
},
/api/Employees/{id}: {
get: {
tags: [
"Employees"
],
parameters: [
{
name: "id",
in: "path",
required: true,
schema: {
type: "string",
format: "uuid"
}
}
],
responses: {
200: {
description: "Success"
}
}
},
put: {
tags: [
"Employees"
],
parameters: [
{
name: "id",
in: "path",
required: true,
schema: {
type: "string",
format: "uuid"
}
}
],
requestBody: {
content: {
application/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
text/json: {
schema: {
$ref: "#/components/schemas/Employee"
}
},
application/*+json: {
schema: {
$ref: "#/components/schemas/Employee"
}
}
}
},
responses: {
200: {
description: "Success"
}
}
},
delete: {
tags: [
"Employees"
],
parameters: [
{
name: "id",
in: "path",
required: true,
schema: {
type: "string",
format: "uuid"
}
}
],
responses: {
200: {
description: "Success"
}
}
}
},
/api/TzGemeinden: {
get: {
tags: [
"TzGemeinden"
],
responses: {
200: {
description: "Success"
}
}
}
},
/WeatherForecast: {
get: {
tags: [
"WeatherForecast"
],
operationId: "GetWeatherForecast",
responses: {
200: {
description: "Success",
content: {
text/plain: {
schema: {
type: "array",
items: {
$ref: "#/components/schemas/WeatherForecast"
}
}
},
application/json: {
schema: {
type: "array",
items: {
$ref: "#/components/schemas/WeatherForecast"
}
}
},
text/json: {
schema: {
type: "array",
items: {
$ref: "#/components/schemas/WeatherForecast"
}
}
}
}
}
}
}
}
},
components: {
schemas: {
Employee: {
type: "object",
properties: {
id: {
type: "string",
format: "uuid"
},
name: {
type: "string",
nullable: true
},
email: {
type: "string",
nullable: true
},
phone: {
type: "integer",
format: "int64"
},
salary: {
type: "integer",
format: "int64"
},
department: {
type: "string",
nullable: true
}
},
additionalProperties: false
},
WeatherForecast: {
type: "object",
properties: {
date: {
type: "string",
format: "date-time"
},
temperatureC: {
type: "integer",
format: "int32"
},
temperatureF: {
type: "integer",
format: "int32",
readOnly: true
},
summary: {
type: "string",
nullable: true
}
},
additionalProperties: false
}
}
}
}

Any idea whats going wrong here?

Thanks for any support.

br, Robert

Top Replies

100

Offline Pablo Moleri posted over 1 year ago in reply to Anthony Marler +1 verified
Hi Anthony, Sorry that we missed your last reply. Anthony Marler said: But I think the issue is returning an IResult? Exactly. Results.Ok() is an...view reply »

Parents

No Data

Reply

16310

Offline Hristo Anastasov posted over 1 year ago

Hey Robert,

Currently, AppBuilder only support endpoints returning array or object. If the greyed out endpoints are ones that return primitive types, this is the reason for them to appear greyed out, let me verify that and provide more info. Meanwhile, is it possible that you reurn the "original" OpenAPi definiton file? It will contain quotes around namings, which is essential when parsing the content as JSON.
Cancel
Reply

Cancel

Children

16310

Offline Hristo Anastasov posted over 1 year ago in reply to Hristo Anastasov
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" } } } } } }
Cancel
Reply

Cancel