influxdata / influxdata/openapi

Missing dialect param in`/api/v2/scripts/{scriptID}/invoke`

Open
#274 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

By default the response csv from '/api/v2/scripts/{scriptID}/invoke' is annotated with only with the column names.

Similar like a /api/v2/query the /api/v2/scripts/{scriptID}/invoke API should contain optional dialect (https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions).

The client libraries uses also 'group', 'datatype' and 'default' annotations to be able correctly handle data types, default values and determine if a value is a tag.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Inspect the OpenAPI definition for /api/v2/scripts/{scriptID}/invoke and compare it with the /api/v2/query definition. Check how the dialect parameter and the group, datatype, and default annotations are represented; done means the invoke endpoint documents the optional dialect and required CSV annotations consistently with the query API.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.