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.

Sign up for GitHub

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

Jump to bottom

Updated .NET samples #1353

Closed
wants to merge 2 commits into from
Closed

Updated .NET samples #1353

wants to merge 2 commits into from

Conversation

geel9
Copy link
Member

@geel9 geel9 commented Mar 22, 2023

  • Updated .NET Samples
    • Does not include SearchRegistry sample -- @tmarkovski please advise (current samples don't include an example query)
  • Uses following baseline parameters:
    • Ecosystem name: my-ecosystem
    • Template:
      • Name: An Example Credential / an-example-credential / urn:template:my-ecosystem:an-example-credential
      • Fields: firstName, lastName, age
    • Wallet email: [email protected]
    • Credential ID: urn:uuid:7afd0191-9656-3a51-c12f-44ecfbb5a829
    • Revocation ID: urn:revocation-registry:my-ecosystem:AD9wKZCr4zVxat1XSawScD#42
    • Trust Registry ID: urn:egf:my-ecosystem:1297e60abb3b425faaaf0f0a551aae2c

@github-actions
Copy link
Contributor

Preview docs site for JC/dotnet-samples@bb2f3479
Changed paths:

  1. docs/go/index.md
  2. docs/reference/index.md
  3. docs/reference/other/openid.md
  4. docs/reference/proto/index.md
  5. docs/reference/services/accessmanagement-service.md
  6. docs/reference/services/accessmanagement_service_examples.md
  7. docs/reference/services/account-service.md
  8. docs/reference/services/account_service_examples.md
  9. docs/reference/services/credential-service.md
  10. docs/reference/services/credentialtemplates_service_examples.md
  11. docs/reference/services/file-management-service.md
  12. docs/reference/services/filemanagement_service_examples.md
  13. docs/reference/services/provider-service.md
  14. docs/reference/services/provider_service_examples.md
  15. docs/reference/services/template-service.md
  16. docs/reference/services/trust-registry-service.md
  17. docs/reference/services/trustregistry_service_examples.md
  18. docs/reference/services/universalwallet_service_examples.md
  19. docs/reference/services/verifiablecredential_service_examples.md
  20. docs/reference/services/wallet-service.md
  21. docs/walkthroughs/vaccination.md

fundthmcalculus
fundthmcalculus suggested changes Mar 23, 2023
View reviewed changes
Copy link
Contributor

@fundthmcalculus fundthmcalculus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, I approve of the code snippets. Let's not conflate the removal of deprecated endpoints from the docs with code snippet creation.

docs/reference/services/provider-service.md Outdated
Comment on lines 126 to 145
## RetrieveDomainVerificationRecord

Retrieve a random hash TXT that can be used to verify domain ownership

{{ proto_sample_start("services.provider.v1.Provider.RetrieveDomainVerificationRecord") }}
{{ proto_sample_code("services.provider.v1.Provider.RetrieveDomainVerificationRecord") }}
{{ proto_method_tabs("services.provider.v1.Provider.RetrieveDomainVerificationRecord") }}

---

## RefreshDomainVerificationStatus

Call to verify domain

{{ proto_sample_start("services.provider.v1.Provider.RefreshDomainVerificationStatus") }}
{{ proto_sample_code("services.provider.v1.Provider.RefreshDomainVerificationStatus") }}
{{ proto_method_tabs("services.provider.v1.Provider.RefreshDomainVerificationStatus") }}

---

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are these removed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is we had agreed at some point that these should not be part of the public-facing SDK but rather the job of the Dashboard -- I can add samples back in if we like but I'd prefer to move forward with porting them out of the SDK.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Let's remove these.

docs/reference/services/provider-service.md Outdated
Comment on lines 79 to 114
<!--
// This call is not yet implemented
## List Ecosystems

Lists all available ecosystem for the current authentication context.

When using one of the SDKs, you must supply an [List Ecosystem Request](../proto/index.md#listecosystemrequest) object. This object follows the model below:

{{ proto_message('services.provider.v1.ListEcosystemRequest') }}

The response model is of type [List Ecosystem Response](../proto/index.md#listecosystemresponse):

{{ proto_message('services.provider.v1.ListEcosystemResponse') }}
-->

## Invite

This will be removed May 1, 2023
Invite a user to the ecosystem

{{ proto_sample_start("services.provider.v1.Provider.Invite") }}
{{ proto_sample_code("services.provider.v1.Provider.Invite") }}
{{ proto_method_tabs("services.provider.v1.Provider.Invite") }}

---

## InvitationStatus

This will be removed May 1, 2023
Check the status of an invitation

{{ proto_sample_start("services.provider.v1.Provider.InvitationStatus") }}
{{ proto_sample_code("services.provider.v1.Provider.InvitationStatus") }}
{{ proto_method_tabs("services.provider.v1.Provider.InvitationStatus") }}

---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to remove these yet?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These haven't been called a single time in the past month and we plan to remove them shortly -- might as well bite the bullet and not perform the work of documenting endpoints that are effectively already dead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@janpieterz thoughts?

@geel9
Copy link
Member Author

geel9 commented Mar 23, 2023

Overall, I approve of the code snippets. Let's not conflate the removal of deprecated endpoints from the docs with code snippet creation.

Fair -- I'll make a separate PR and the discussion can live there

@geel9
Copy link
Member Author

geel9 commented Apr 13, 2023

Moving to draft as we are pausing this work

@geel9 geel9 marked this pull request as draft April 13, 2023 14:40
@tmarkovski
Copy link
Member

Bump @geel9 @fundthmcalculus . We still want this in or can it be closed?

@geel9 geel9 closed this Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fundthmcalculus fundthmcalculus fundthmcalculus requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@geel9 @tmarkovski @fundthmcalculus