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.

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

Change Request: Provide a complete guideline for Go #7409

Open
mirusky opened this issue Apr 7, 2024 · 2 comments
Open

Change Request: Provide a complete guideline for Go #7409

mirusky opened this issue Apr 7, 2024 · 2 comments
Assignees
Labels
architecture board-review Request for an Architectural Board Review

Comments

@mirusky
Copy link

mirusky commented Apr 7, 2024

Thank you for contributing to the design guidelines for Azure SDKs. We welcome all discussions and contributions. Since the design guidelines affect the client libraries for all Azure services, we thoroughly discuss and vet any design guideline changes before we incorporate them into the official guidance. This process can take some time, so your patience is appreciated.

** Before submitting, ensure you adjust the title of the issue appropriately **

The Basics

We are creating a Go client to azure partner center, and we are using the azure skd guidelines, so in a near future it can be integrated into MS open source / community. But since the Guideline still in draft we can't proceed further, for the lack of examples.

  • Which design guideline is affected?
    Azure SDK for Go

  • Which target languages are affected?
    Go

  • Describe the change:
    Provide a better examples and finished API.

Reasoning

Please provide any additional detail or reasoning for the request.

Currently the documentation is incomplete, with lack of examples and informations.

@mirusky mirusky added architecture board-review Request for an Architectural Board Review labels Apr 7, 2024
@sandeep-sen sandeep-sen self-assigned this Apr 8, 2024
@sandeep-sen
Copy link
Member

@mirusky which service is this SDK targeting? It would take sometime for us to move this guideline to a stable. We would be happy to consult with your group if we have more details.

@mirusky
Copy link
Author

mirusky commented Apr 15, 2024

We are implementing a go client for the Partner Center (PC), following the practices described by azure guideline for Go.

Since the Partner Center and Azure has same authentication method, and PC is majorithority listing, pooling and simple creations. We thought that using az score + az guidelines, would fit and produce a rapid development.

But currently the main issue is the lacking of informations, since PC has a lot nested calls like:

/invoices 
/invoices/summary
/invoices/<invoiceID>/lineitems
/invoices/estimates/links

We don't know how this will be translated into the azure guideline, since the documentation doesn't have a clear example of nested clients.

The currently implementation we kind of followed the template of azure go sdk, but with some modifications:

.
├───invoices
│   ├───estimates
│   ├───lineitems
│   ├───statement
│   ├───summaries
│   └───taxreceipts
├───models.go
├───client.go
├───options.go
└───responses.go

and the client has dependents clients like:

type Client struct {
	SummariesClient *summaries.Client
	LineItemsClient *lineitems.Client
	pipeline        runtime.Pipeline
}

We would be grateful, with the guideline being updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
architecture board-review Request for an Architectural Board Review
Projects
None yet
Development

No branches or pull requests

4 participants