Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OpenAPI consistency pass #241

Merged
merged 1 commit into from
Dec 9, 2022
Merged

OpenAPI consistency pass #241

merged 1 commit into from
Dec 9, 2022

Conversation

nfx
Copy link
Contributor

@nfx nfx commented Dec 9, 2022

  • merged dbsql and warehouses to sql pacakge
  • unified operationId naming for sql, globalinitscripts, ipaccesslists, unitycatalog, and pipelines packages
  • normalized type structure for unitycatalog package
  • set required field indicators where applicable

@nfx
OpenAPI consistency pass
ecbff57 
* merged `dbsql` and `warehouses` to `sql` pacakge
* unified `operationId` naming for `sql`, `globalinitscripts`, `ipaccesslists`, `unitycatalog`, and `pipelines` packages
* normalized type structure for `unitycatalog` package
* set required field indicators where applicable
@codecov-commenter
Copy link

Codecov Report

Base: 43.19% // Head: 43.19% // No change to project coverage 👍

Coverage data is based on head (ecbff57) compared to base (471594e).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #241   +/-   ##
=======================================
  Coverage   43.19%   43.19%           
=======================================
  Files          42       42           
  Lines        2396     2396           
=======================================
  Hits         1035     1035           
  Misses       1279     1279           
  Partials       82       82
Impacted Files Coverage Δ
openapi/code/service.go 59.81% <ø> (ø)
service/clusters/model.go 0.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@nfx nfx merged commit d675947 into main Dec 9, 2022
@nfx nfx deleted the gen/improvements branch December 9, 2022 20:46
@nfx nfx mentioned this pull request Dec 23, 2022
Merged
nfx added a commit that referenced this pull request Dec 23, 2022
@nfx
Release v0.2.0 (#264)
a106cca 
# Version changelog

## 0.2.0

* Added `DATABRICKS_AUTH_TYPE` environment variable
([#248](#248)).
* Added Policy Families API
([#263](#263)).
* Added experimental `ErrCannotConfigureAuth` and `ErrNotAccountClient`
([#237](#237),
[#238](#238)).
* Added DBFS file handle that supports both reading and writing
([#261](#261)).
* Added `io.WriterTo` for DBFS file reader
([#249](#249)).
* Added `pflag.Value` interfaces for enums
([#234](#234)).
* Added support for adding custom HTTP visitors per request
([#230](#230)).
* Added support for raw body as byte slice if requested
([#247](#247)).
* Improved callbacks for polling the status of long-running operations
([#258](#258)).
* Improved rendering of HTTP links in godoc
([#229](#229)).
* Updated field types in the Jobs API from spec
([#259](#259)).
* Multiple OpenAPI consistency passes
([#254](#254),
[#241](#241),
[#243](#243),
[#255](#255),
[#236](#236)).

API changes:
* Renamed `IsAccountsClient` to `IsAccountClient`
([#231](#231)).
* `w.ClusterPolicies.ListAll` now takes `clusterpolicies.List` as an
argument.
* `github.com/databricks/databricks-sdk-go/service/dbsql` package is
renamed to `github.com/databricks/databricks-sdk-go/service/sql`.
 * `w.DataSources.ListDataSources` is renamed to `w.DataSources.List`.
 * `w.Queries.CreateQuery` is renamed to `w.Queries.CreateQuery`.
* `w.Queries.DeleteQueryByQueryId` is renamed to
`w.Queries.DeleteByQueryId`.
 * `w.Queries.GetQueryByQueryId` is renamed to `w.Queries.GetByQueryId`.
 * `w.Queries.UpdateQuery` is renamed to `w.Queries.Update`.
* `w.Alerts.DeleteAlertByAlertId` is renamed to
`w.Alerts.DeleteByAlertId`.
 * `w.Alerts.UpdateAlert` is renamed to `w.Alerts.Update`.
 * `w.Alerts.GetAlertByAlertId` is renamed to `w.Alerts.GetByAlertId`.
 * `w.Alerts.ListAlerts` is renamed to `w.Alerts.List`.
 * `w.Dashboards.CreateDashboard` is renamed to `w.Dashboards.Create`.
* `w.Dashboards.DeleteDashboardByDashboardId` is renamed to
`w.Dashboards.GetByDashboardId`.
* `w.Dashboards.ListDashboardsAll` is renamed to `w.Dashboards.ListAll`.
* `w.Dashboards.DeleteDashboardByDashboardId` is renamed to
`w.Dashboards.DeleteByDashboardId`.
 * `w.Dashboards.RestoreDashboard` is renamed to `w.Dashboards.Restore`.
* `deployment.CreateCustomerManagedKeyRequest` now takes
`deployment.KeyUseCase` enum.
* `w.GlobalInitScripts.CreateScript` is renamed to
`w.GlobalInitScripts.Create`.
* `w.GlobalInitScripts.DeleteScriptByScriptId` is renamed to
`w.GlobalInitScripts.DeleteByScriptId`.
* `w.GlobalInitScripts.UpdateScript` is renamed to
`w.GlobalInitScripts.Update`.
* `w.GlobalInitScripts.GetScriptByScriptId` is renamed to
`w.GlobalInitScripts.GetByScriptId`.
* `w.GlobalInitScripts.ListScriptsAll` is renamed to
`w.GlobalInitScripts.ListAll`.
 * `jobs.ResetJob.NewSettings` is now required field.
 * `w.Pipelines.CreatePipeline` is renamed to `w.Pipelines.Create`.
* `w.Pipelines.DeletePipelineByPipelineId` is renamed to
`w.Pipelines.DeleteByPipelineId`.
 * `w.Pipelines.UpdatePipeline` is renamed to `w.Pipelines.Update`.
* `w.Pipelines.GetPipelineByPipelineId` is renamed to
`w.Pipelines.GetByPipelineId`.
 * `w.StorageCredentials.Update` now also returns an entity.
 * `w.ExternalLocations.Update` now also returns an entity.
 * `w.Metastores.Update` now also returns an entity.
* `unitycatalog.CreateMetastoreAssignment.WorkspaceId` type changed from
`int` to `int64`.
* `unitycatalog.UnassignRequest.WorkspaceId` type changed from `int` to
`int64`.
 * `w.Catalogs.Update` now also returns an entity.
 * `w.Schemas.Update` now also returns an entity.
 * `w.Providers.Update` now also returns an entity.
 * `w.Shares.Update` now also returns an entity.
* `WarehousesAPI` service moved to
`github.com/databricks/databricks-sdk-go/service/sql` package.
* `w.Warehouses.CreateWarehouseAndWait` renamed to
`w.Warehouses.CreateAndWait`.
* `w.Warehouses.DeleteWarehouseByIdAndWait` renamed to
`w.Warehouses.DeleteByIdAndWait`.
 * `w.Warehouses.EditWarehouse` renamed to `w.Warehouses.Edit`.
 * `w.Warehouses.GetWarehouseById` renamed to `w.Warehouses.GetById`.
 * `w.Warehouses.ListWarehousesAll` renamed to `w.Warehouses.ListAll`.
* Removed `w.Dbfs.Overwrite` in favor of `w.Dbfs.Open("....",
dbfs.FileModeOverwrite|dbfs.FileModeWrite)`.
 * Added third required argument to `w.Dbfs.Open`.

Code generation:

* Added concept of `main` service for the package
([#239](#239)).
* Added entity primitives check
([#242](#242)).
* Added helpers for CRUD generation
([#246](#246)).
* Added more entity-generation utils
([#257](#257)).
* Dynamically generate `.gitattributes`
([#244](#244)).
* Fixed required order fields
([#245](#245)).
* Parse summary from descriptions
([#228](#228)).
* Print error on formatter failure
([#235](#235)).
* Update usage string in generator
([#260](#260)).
* Fixed order of host completion
([#233](#233)).

Dependency updates:

* Bump google.golang.org/api from 0.103.0 to 0.105.0
([#232](#232),
[#252](#252)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nfx @codecov-commenter