Mleap Spring Boot Swagger Documentation Seems Incorrect

Open
#861 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi, spring-boot
Domain
api, documentation

Research direction

Start at the Swagger/OpenAPI definition for /models/{modelName}/transform and compare its example request with the reported error for the supplied body. Done means the documented request matches the endpoint's accepted schema and explains valid type values; the issue names no source file or test.

Written by the indexing model from the issue text.

Description

Hi,

I have been exploring the mleap-spring-boot project. The swagger documentation seems to be off for the transform endpoint.

In the swagger for the endpoint --> /models/{modelName}/transform
It mentions that the body is supposed to be the following:

{
"schema": {
"fields": [
{
"name": "string",
"dataType": {
"base": "BOOLEAN",
"shape": {
"base": "SCALAR",
"isNullable": true,
"tensorShape": [
{
"size": 0,
"name": "string"
}
]
}
}
}
]
},
"rows": [
[
{}
]
]
}

However, when you use that body there is an error --> "error": "NoSuchElementException: key not found: type",

Seems like a type field is required. Am i missing something? Also what are valid values for type.

Thank you for help, much appreciated.

Dominant language
Scala
Stars
1.5k
Forks
313
Avg merge
22m
Merged PRs (30d)
1

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from combust/mleap

All issues in combust/mleap

Similar issues

More Scala issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.