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

Update SDK godocs #2275

Open
nyagamunene opened this issue Jun 5, 2024 · 1 comment
Open

Update SDK godocs #2275

nyagamunene opened this issue Jun 5, 2024 · 1 comment
Labels

Comments

@nyagamunene
Copy link
Contributor

What were you trying to achieve?

Currently the SDK godocs are outdated from the recent changes.

What are the expected results?

Update SDK godocs to reflect recent changes.

What are the received results?

Past permissions like owner is still in the docs but they are no longer being used. Some of the examples are failing.

Steps To Reproduce

  1. Update the relations and permissions.
  2. Test and update the examples individually.

In what environment did you encounter the issue?

Magistrala

Additional information you deem important

No response

@nyagamunene nyagamunene added the bug label Jun 5, 2024
@arvindh123
Copy link
Contributor

Some of the SDK function godocs have invalid relations ,
Listing endpoints of groups and channel (may be domain ) can list with Permissions and Relations
We need to check the funcationalies of endpoints and update the godocs for List , assign ,unassign and other endpoint

Example:
In below function , godocs have owner but we don't have owner relation. Like we need to check and modify the godocs

	// ListUserChannels list all channels belongs a particular user id.
	//
	// example:
	//	pm := sdk.PageMetadata{
	//		Offset: 0,
	//		Limit:  10,
	//		Permission: "edit", // available Options:  "administrator", "delete", edit", "view", "share", "owner", "admin", "editor", "viewer"
	//	}
	//  channels, _ := sdk.ListUserChannels("user_id_1", pm, "token")
	//  fmt.Println(channels)
	ListUserChannels(userID string, pm PageMetadata, token string) (ChannelsPage, errors.SDKError)
	```

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: ⛏ Backlog
Development

No branches or pull requests

2 participants