[EventGrid] Read me + improve docstrings #13484
Conversation
ghost
added
the
rakshith91
requested review from
KieranBrantnerMagee
and removed request for
kalyanaj
|
|
||
| ## Key concepts | ||
|
|
||
| ### EventGridPublisherClient |
There was a problem hiding this comment.
Another learning from SB that was received positively was turning the key concept headers into URLs pointing at the long-form docs for that relevant concept.
There was a problem hiding this comment.
Nice idea - but there are no published docs for track2 yet :( - will add later instead of adding broken links now
There was a problem hiding this comment.
To be clear; not to published track2 docs, but like the "official service docs" to what that concept means, e.g. in the servicebus case for Queue we linked here
|
|
||
| **Breaking Changes** | ||
|
|
||
| - Implements the `EventGridPublisherCloent` for the publish flow for EventGrid Events, CloudEvents and CustomEvents. |
There was a problem hiding this comment.
| - Implements the `EventGridPublisherCloent` for the publish flow for EventGrid Events, CloudEvents and CustomEvents. | |
| - Implements the `EventGridPublisherClient` for the publish flow for EventGrid Events, CloudEvents and CustomEvents. |
|
|
||
| For more information about this, and preview releases of other Azure SDK libraries, please visit https://azure.github.io/azure-sdk/releases/latest/python.html. | ||
|
|
||
| **Breaking Changes** |
There was a problem hiding this comment.
So looking at what you put under here, I'm not sure I follow the categorizations. I'd probably put these under Features (and put that header above your top-level preview effort snippet), and if you wanted a breaking changes section (which I thought was reasonable) you could mention the deprecation of the track-1 publishing method?
| client.send(event) | ||
| ``` | ||
|
|
||
| ### Consume an eventgrid Event |
There was a problem hiding this comment.
| ### Consume an eventgrid Event | |
| ### Consume an EventGrid Event |
(and the award for the most bikesheddy change goes to... :P)
| "dataVersion":"2.0", | ||
| "metadataVersion":"1", | ||
| "eventTime":"2020-08-07T02:28:23.867525Z", | ||
| "topic":"/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/t-swpill-test/providers/Microsoft.EventGrid/topics/eventgridegsub" |
There was a problem hiding this comment.
(I realize in hindsight we may want to anonymize some of this away from Swathi's bits so as to not confuse folks)
…into link_om_sample * 'master' of https://github.com/Azure/azure-sdk-for-python: (23 commits) Int32 serialization (Azure#13452) add output to opinion mining sample (Azure#13494) Add Document w/ Eng Sys Checks (Azure#13492) update version (Azure#13495) Remove resources post test (Azure#13379) bing_id -> bing_entity_search_api_id (Azure#13491) [EventGrid] Read me + improve docstrings (Azure#13484) Build AuthenticationRecords from ADFS identity tokens (Azure#13341) Support Subject Name/Issuer authentication (Azure#13350) Add KeyVaultAccessControlClient for data plane RBAC (Azure#13372) [text analytics] Add redacted_text (Azure#13449) add python sdk sample (Azure#13338) [text analytics] add versionadded sphinx documentation (Azure#13450) [text analytics] add bing_id property to LinkedEntity class (Azure#13446) fix typing for paging methods (Azure#13410) [text analytics] add domain_filter param (Azure#13451) fix issue Azure#11658 for is_valid_resource_id (Azure#11709) added create_table_if_not_exists method to table service client (Azure#13385) [ServiceBus] Test and failure improvements (Azure#13345) Proper encoding and decoding of source URLs - Fixes special characters in source URL issue (Azure#13275) ...
* Read me + docstrings * Update sdk/eventgrid/azure-eventgrid/CHANGELOG.md * comments * comment * one more * add one more line * nti
Fixes #13223