[jira] [Resolved] (SPARK-31566) Add SQL Rest API Documentation

["Gengliang Wang (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SPARK-31566?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gengliang Wang resolved SPARK-31566.
------------------------------------
    Resolution: Fixed

This issue is resolved in https://github.com/apache/spark/pull/28354 

> Add SQL Rest API Documentation
> ------------------------------
>
>                 Key: SPARK-31566
>                 URL: https://issues.apache.org/jira/browse/SPARK-31566
>             Project: Spark
>          Issue Type: Documentation
>          Components: Documentation, SQL
>    Affects Versions: 3.1.0
>            Reporter: Eren Avsarogullari
>            Assignee: Eren Avsarogullari
>            Priority: Major
>
> SQL Rest API exposes query execution metrics as Public API. Its documentation will be useful for end-users. 
> {code:java}
> /applications/[app-id]/sql
> 1- A list of all queries for a given application.
> 2- ?details=[true|false (default)] lists metric details in addition to queries details.
> 3- ?offset=[offset]&length=[len] lists queries in the given range.{code}
> {code:java}
> /applications/[app-id]/sql/[execution-id]
> 1- Details for the given query.
> 2- ?details=[true|false (default)] lists metric details in addition to given query details.{code}



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org