search

Azure / azure-sdk

This is the Azure SDK parent repository and mostly contains documentation around guidelines and policies as well as the releases for the various languages supported by the Azure SDK.
http://azure.github.io/azure-sdk
MIT License
478 stars 295 forks source link

Board Review: azure-cosmos-db-query-editor React Component published as azure/ NPM package #5287

Open languy opened 1 year ago

languy commented 1 year ago

Contacts and Timeline

About the Service

We are developing a Query Editor that can be consumed by our various open-source projects. The query editor is a small UI typescript React component. It allows the user to input a query and displays its result in a collapsible tree form or simply as a JSON string. It is defined to be integrated into a React app. The plan is to release this component as an NPM package, so that our other typescript open-source projects can consume it. Although the purpose is mainly for code-sharing (it is not our main product), the query editor is implemented as a generic re-usable component. The project has received approval from our MS OSS folks to open-source and for the repo name.

Link to azure-cosmos-db-query-editor github repo. Although the definition file is automatically generated, here is the current component API top-level file.

We were advised to release the npm package as a scoped package and the suggestion was to contact this team to get approval for the azure scope.

About the client library

Artifacts required (per language)

The artifacts include a minified javascript module and its typescript definition file which are generated at build time by parcel.

TypeScript

The documentation on how to use is not yet written as the API is still in flux, but there is a test application that integrates the component in this file.

Thank you!

ronniegeraghty commented 1 year ago

Scheduled for Feb 1st from 2:05PM - 4PM PST.