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

Doc comments for API interface are too thin #139

Open
atc0005 opened this issue Feb 7, 2022 · 0 comments
Open

Doc comments for API interface are too thin #139

atc0005 opened this issue Feb 7, 2022 · 0 comments
Assignees
Labels
api bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@atc0005
Copy link
Owner

atc0005 commented Feb 7, 2022

go-teams-notify/send.go

Lines 87 to 95 in eaab5cd

// API - interface of MS Teams notify
type API interface {
Send(webhookURL string, webhookMessage MessageCard) error
SendWithContext(ctx context.Context, webhookURL string, webhookMessage MessageCard) error
SendWithRetry(ctx context.Context, webhookURL string, webhookMessage MessageCard, retries int, retriesDelay int) error
SkipWebhookURLValidationOnSend(skip bool) API
AddWebhookURLValidationPatterns(patterns ...string) API
ValidateWebhook(webhookURL string) error
}

This is functional and was likely fine when the API surface was smaller, but should be extended to cover existing functionality.

@atc0005 atc0005 added bug Something isn't working documentation Improvements or additions to documentation api labels Feb 7, 2022
@atc0005 atc0005 added this to the Next Release milestone Feb 7, 2022
@atc0005 atc0005 self-assigned this Feb 7, 2022
atc0005 added a commit that referenced this issue Feb 25, 2022
OVERVIEW

- Revert "Allow overriding default http.Client"
- Revert "Set project-specific user agent, offer override"

REFERENCES

- 884e59f
- 26ac7b4
- GH-134
- GH-135
- GH-139
atc0005 added a commit that referenced this issue Feb 25, 2022
OVERVIEW

- Revert "Allow overriding default http.Client"
- Revert "Set project-specific user agent, offer override"

REFERENCES

- 884e59f
- 26ac7b4
- GH-134
- GH-135
- GH-139
@atc0005 atc0005 modified the milestones: v2.7.0, Future Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant