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

[Documentation] CreateAuthCodeURL Naming Consistency #371

Closed
1 of 5 tasks
dannmartens opened this issue Jan 18, 2023 · 1 comment · Fixed by #384
Closed
1 of 5 tasks

[Documentation] CreateAuthCodeURL Naming Consistency #371

dannmartens opened this issue Jan 18, 2023 · 1 comment · Fixed by #384
Labels
documentation Improvements or additions to documentation

Comments

@dannmartens
Copy link

Documentation related to component

Inconsistent method naming across confidential and public Clients:
AuthCodeURL vs. CreateAuthCodeURL

Please check all that apply

  • typo
  • documentation doesn't exist
  • documentation needs clarification
  • error(s) in the example
  • needs an example

Description of the issue

confidential:

[func (cca Client) AuthCodeURL(ctx context.Context, clientID, redirectURI string, scopes []string) (string, error)](https://pkg.go.dev/github.com/AzureAD/microsoft-authentication-library-for-go@v0.7.0/apps/confidential#Client.AuthCodeURL)

public:

[func (pca Client) CreateAuthCodeURL(ctx context.Context, clientID, redirectURI string, scopes []string) (string, error)](https://pkg.go.dev/github.com/AzureAD/microsoft-authentication-library-for-go@v0.7.0/apps/public#Client.CreateAuthCodeURL)

While I report this as a documentation issue, fixing this obviously will cause an API change.

@dannmartens dannmartens added the documentation Improvements or additions to documentation label Jan 18, 2023
@dannmartens dannmartens changed the title [Documentation] [Documentation] CreateAuthCodeURL Naming Consistency Jan 18, 2023
@chlowell
Copy link
Collaborator

Thanks for opening this issue! We decided to change the API and will rename CreateAuthCodeURL to AuthCodeURL in the next version.

@rayluo rayluo mentioned this issue Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants