"Test it" tool for AI ask is prepopulated with erroneous request body

[benjamincburns]

It appears that all of the AI ask endpoints descriptions on this page show the body as only requiring a query parameter. However, if you go to run a request via the "Test it" button on that page, the editor loads with the following request body prepopulated:

{
  "query": "",
  "previousQueries": [
    null
  ]
}

If you fill in your query and run it as-is, without editing the contents of the previousQueries array, you'll get the following 422 error response:

{
  "error": {
    "code": 422,
    "message": "body.previousQueries.0: expected a string"
  }
}

Editing the body to make previousQueries be an empty array, or deleting previousQueries entirely causes the request to succeed. Given that previousQueries is deprecated and appears to no longer be functional, I'd think it should be removed from the "Test it" tool.

[talagluck]

Hi @benjamincburns, thanks for opening this! We've logged this internally and will triage this in an upcoming cycle.

Please feel free to leave us any additional context that may be helpful.

[benjamincburns]

I'm no longer in the role and no longer use GitBook, so I'm afraid I can't share any additional context. I do recall the API docs being a bit terse, and I remember having to do a bunch of my own "try and see" work to figure out how to put requests together to do what I wanted, or to determine what the actual response structures would be, but unfortunately I can't recall enough specifics about it to give any kind of repro advice.

[talagluck]

I appreciate the follow-up!