Release 1.0.7#2
Conversation
There was a problem hiding this comment.
Pull request overview
Release 1.0.7 focuses on documenting the SDK/spec alignment work and formally deprecating legacy/undocumented endpoints while reorganizing usage examples.
Changes:
- Added new documentation files (
ROADMAP.md,CHANGELOG.md,AI_INSTRUCTIONS.md,EXAMPLES.md) and moved examples out ofREADME.md. - Marked selected legacy endpoints as deprecated via
[Obsolete]attributes (Rules, Domains create/delete, Messages “latest” wildcard). - Bumped package version to
1.0.7(and updated copyright year).
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| ROADMAP.md | Adds a high-level roadmap and spec/SDK gap analysis snapshot. |
| README.md | Removes large inlined examples and points readers to EXAMPLES.md. |
| mailinator-csharp-client/mailinator-csharp-client.csproj | Version bump to 1.0.7 and metadata updates. |
| mailinator-csharp-client/Clients/ApiClients/Rules/RulesClient.cs | Deprecates Rules endpoints via [Obsolete]. |
| mailinator-csharp-client/Clients/ApiClients/Messages/MessagesClient.cs | Deprecates “latest” wildcard endpoints via [Obsolete]. |
| mailinator-csharp-client/Clients/ApiClients/Domains/DomainsClient.cs | Deprecates domain create/delete endpoints via [Obsolete]. |
| EXAMPLES.md | Introduces consolidated copy/paste examples. |
| CHANGELOG.md | Adds a changelog with 1.0.7 entries. |
| AI_INSTRUCTIONS.md | Documents SDK structure and spec-alignment audit workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| var created = await client.DomainsClient.CreateDomainAsync( | ||
| new CreateDomainRequest { Name = $"test{DateTime.UtcNow.Ticks}.testinator.com" }); | ||
|
|
||
| var deleted = await client.DomainsClient.DeleteDomainAsync( | ||
| new DeleteDomainRequest { DomainId = "yourDomainIdHere" }); |
There was a problem hiding this comment.
This example uses CreateDomainAsync/DeleteDomainAsync, which are now marked [Obsolete] in DomainsClient in this release. Add an explicit note here (or move these snippets under a “Deprecated” section) so users don’t copy/paste code that immediately produces compiler warnings.
| var latest = await client.MessagesClient.FetchLatestMessagesAsync( | ||
| new FetchLatestMessagesRequest { Domain = "yourDomainNameHere" }); |
There was a problem hiding this comment.
FetchLatestMessagesAsync is now marked [Obsolete] in this release. This example should be clearly labeled as deprecated (or removed) to prevent users from adopting the wildcard “latest” endpoints going forward.
| using mailinator_csharp_client.Models.Webhooks.Entities; | ||
| using mailinator_csharp_client.Models.Webhooks.Requests; | ||
|
|
||
| var client = new MailinatorClient("yourApiTokenHere"); |
There was a problem hiding this comment.
Webhook injection endpoints are documented in-code as not using the regular API token (auth should be via the whtoken query param). Using new MailinatorClient("yourApiTokenHere") here is misleading; prefer new MailinatorClient() (or explicitly note that the API token is not required/used for webhook calls).
| var client = new MailinatorClient("yourApiTokenHere"); | |
| var client = new MailinatorClient(); |
| ## Current Status (to fill in) | ||
|
|
||
| - Latest published package version: | ||
| - Target frameworks: | ||
| - API coverage vs spec: | ||
| - Known gaps / bugs: | ||
|
|
There was a problem hiding this comment.
This section is labeled “to fill in” and currently contains empty bullets. For a tagged release, either populate these values (latest version, TFMs, coverage, gaps) or remove the placeholder section so the published roadmap doesn’t look incomplete.
| ## Current Status (to fill in) | |
| - Latest published package version: | |
| - Target frameworks: | |
| - API coverage vs spec: | |
| - Known gaps / bugs: |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ilinator-csharp-client into codex/release-1.0.7
So far the only changes are deprecating endpoints and some doc additions / updates.