search

okta / okta-sdk-golang

A Golang SDK for interacting with the Okta management API, enabling server-side code to manage Okta users, groups, applications, and more.
https://github.com/okta/okta-sdk-golang
Other
174 stars 143 forks source link

documentation contains encoded HTML #358

Closed soniah closed 1 year ago

soniah commented 1 year ago

Describe the bug?

The documentation contains encoded html. For example the function ChangePassword looks like this:

// Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential
func (m *UserResource) ChangePassword(ctx context.Context, userId string, body ChangePasswordRequest, qp *query.Params) (*UserCredentials, *Response, error) {

when it should look like this:

// Changes a user's password by validating the user's current password. This operation can only be performed on users in "STAGED", "ACTIVE", "PASSWORD_EXPIRED", or "RECOVERY" status that have a valid password credential
func (m *UserResource) ChangePassword(ctx context.Context, userId string, body ChangePasswordRequest, qp *query.Params) (*UserCredentials, *Response, error) {

It also appears like the above on pkg.go.dev

What is expected to happen?

Correct quoting used in documentation.

What is the actual behavior?

See above.

Reproduction Steps?

Reading the documentation.

Additional Information?

No response

Golang Version

go version go1.18.1 darwin/amd64

SDK Version

v2.16.0

OS version

Darwin ELM-C02ZXM6QMD6M 21.6.0 Darwin Kernel Version 21.6.0: Sun Nov 6 23:31:16 PST 2022; root:xnu-8020.240.14~1/RELEASE_X86_64 x86_64 i386 Darwin

github-actions[bot] commented 1 year ago

This issue has been marked stale because there has been no activity within the last 14 days. To keep this issue active, remove the stale label.

github-actions[bot] commented 1 year ago

This issue has been marked stale because there has been no activity within the last 14 days. To keep this issue active, remove the stale label.

github-actions[bot] commented 1 year ago

This issue has been marked stale because there has been no activity within the last 14 days. To keep this issue active, remove the stale label.

monde commented 1 year ago

Thanks @soniah. This is corrected in v3 of the sdk. The HTML escaping was an artifact of the legacy code generator we used in v2.