Update readme where it references data plane crates #192
Conversation
Small change, but it seems like this should read as my change here proposes For comparison, the control plane section reads > The control plane crates are named And so I assume in referencing data plane section here we are referencing data plane crates
|
The readme here doesn't really cover how the data plane crates will be created from the open api specs. As an example,TextAnalytics with it's open api spec at https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.0/TextAnalytics.json but I can't see that a data plane spec such as this is currently automatically parsed into these generated files here. If there is a plan on this, are you able to point out where the proposed approach might be? I'd love to contribute to add some capabilities around the data plane operations if I can |
|
Right now the data plane is hand rolled, but that's mainly because it warranted a level of customization difficult to achieve with a blanket generator (particularly the storage crate). Also we are still exploring the best way to express the API in rust. We strive to be as compile-time stringent as possibile while maintaining a decent ergonomics (as often said in rust, if it compiles, it works™️). I was thinking of writing a quick start guide that should help to get started. That said, once we settle on a way of coding things, we could/should use a generator. |
|
Thanks for the info. I'd love to be able to contribute where I can so a quick start guide and any proposals on a generator I'd love to read |
| @@ -47,11 +47,11 @@ azure_mgmt_storage_2018_02 = { package = "azure_mgmt_storage", git = "https://gi | |||
| ``` | |||
|
|
|||
| ## Data Plane Crates | |||
| The control plane crates will be named `azure_svc_${specification_directory}`, such as `azure_svc_storage`. | |||
| The data plane crates will be named `azure_svc_${specification_directory}`, such as `azure_svc_storage`. | |||
There was a problem hiding this comment.
The data plane crates should ideally match our naming convention for other SDKs. Some like .NET and Java use possible topic-level names like Azure.Security.KeyVault.Secrets while languages like Python and JS simplify it, which may be more applicable here e.g. @azure/keyvault-secrets or azure_keyvault_secrets.
Control (or management) planes are typically Azure.ResourceManager.KeyVault.
Small change, but it seems like this should read as my change here proposes
For comparison, the control plane section reads
And so I assume in referencing data plane section here we are referencing data plane crates