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

[TCSACR-289] Oauth2 C# API deprecated #1206

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

chauhan321
Copy link

@chauhan321 chauhan321 commented Aug 13, 2020

Signed-off-by: kamaljeet chauhan kamal.jc@samsung.com

Change Description

Tizen.Account.OAuth2 is not used by any other module, so deprecating all the public API's of Tizen.Account.OAuth2

Patch info

Samsung/TizenFX#1094

For instance,

Signed-off-by: kamaljeet chauhan <kamal.jc@samsung.com>
@TizenDocsBot
Copy link
Collaborator

checkout the webpage https://docs1.stg.tizen.org/staging/1206

Copy link
Contributor

@journey2w journey2w left a comment

Choose a reason for hiding this comment

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

Please delete OAuth2 in other files as well:

  1. docs/appliation/toc_all.md
  2. docs/application/dotnet/guides/personal/authentication.md

@journey2w journey2w changed the title ACR-289 Oauth2 C# API deprecated [TCSACR-289] Oauth2 C# API deprecated Aug 14, 2020
@chauhan321
Copy link
Author

Please delete OAuth2 in other files as well:

  1. docs/appliation/toc_all.md
  2. docs/application/dotnet/guides/personal/authentication.md

changes are done, please review

@TizenDocsBot
Copy link
Collaborator

checkout the webpage https://docs1.stg.tizen.org/staging/1206

@TizenDocsBot
Copy link
Collaborator

Check Broken Link: Not found any broken link

@mijin85cho
Copy link
Contributor

Thanks for the update, @chauhan321.

  • However, we still have some sentences talking about OAuth 2.0 on application/dotnet/guides/personal/overview.md.
    Would you please remove the sentence related with OAuth 2.0?

    -   [Authentication and Authorization](authentication.md)
    
        You can obtain an access token by using the OAuth 2.0 authorization. The OAuth 2.0 authorization framework enables you to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing you to obtain access on your own behalf. You can also use the FIDO Universal Authentication Framework to authenticate users.
    
  • In the application/dotnet/tutorials/app-filtering.md file, http://tizen.org/feature/oauth2 is listed up in the table.
    I hope you check this page and remove the related feature also.

  • Also, just a question to application/dotnet/guides/personal/account.md to get your confirmation.
    In this page, we have Auth type property in Table: Account properties, related with authentication type.

    | Auth type | Integer | No | Authentication type, such as oauth or xauth. |

    As oauth module is removed, don't we need to fix this row? I'm not sure with related further update about deprecating OAuth, so asking this question to you.

@chauhan321
Copy link
Author

chauhan321 commented Aug 20, 2020

Thanks for the update, @chauhan321.

  • However, we still have some sentences talking about OAuth 2.0 on application/dotnet/guides/personal/overview.md.
    Would you please remove the sentence related with OAuth 2.0?
    -   [Authentication and Authorization](authentication.md)
    
        You can obtain an access token by using the OAuth 2.0 authorization. The OAuth 2.0 authorization framework enables you to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing you to obtain access on your own behalf. You can also use the FIDO Universal Authentication Framework to authenticate users.
    
  • In the application/dotnet/tutorials/app-filtering.md file, http://tizen.org/feature/oauth2 is listed up in the table.
    I hope you check this page and remove the related feature also.
  • Also, just a question to application/dotnet/guides/personal/account.md to get your confirmation.
    In this page, we have Auth type property in Table: Account properties, related with authentication type.
    | Auth type | Integer | No | Authentication type, such as oauth or xauth. |
    As oauth module is removed, don't we need to fix this row? I'm not sure with related further update about deprecating OAuth, so asking this question to you.

Changes are done. I am also not sure about account.md file, as it have just mentioned about all properties of account and they can be generic. so i have not deleted from that file.

@TizenDocsBot
Copy link
Collaborator

checkout the webpage https://docs1.stg.tizen.org/staging/1206

@TizenDocsBot
Copy link
Collaborator

Check Broken Link: Not found any broken link

Copy link
Contributor

@mijin85cho mijin85cho left a comment

Choose a reason for hiding this comment

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

Thanks for the reply, @chauhan321.

Below are my comments with the latest version.

@@ -13,10 +13,6 @@ You can use the following personal data features in your .NET applications:

You can synchronize service application data between a server and the device by creating various sync jobs.

- [Authentication and Authorization](authentication.md)

You can obtain an access token by using the OAuth 2.0 authorization. The OAuth 2.0 authorization framework enables you to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing you to obtain access on your own behalf. You can also use the FIDO Universal Authentication Framework to authenticate users.
Copy link
Contributor

Choose a reason for hiding this comment

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

Oops.. this link should be kept as it is going to authentication.md, which remains after merging this PR. I asked to update just the sentence, as the sentence is mentioning OAuth 2.0 and FIDO Authentication.

Please revert back the removal of this hyperlink, and update the following sentence to mention FIDO Universal Authentication Framework only.

If possible, enhancing the description for FIDO Universal Authentication Framework would be appreciate...

Copy link
Author

Choose a reason for hiding this comment

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

Changes are done, kindly review

Copy link
Contributor

Choose a reason for hiding this comment

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

The enhancing is more than my expectation. As the introducing, we don't need to use heavy sentences here.

How about below?

You can authenticate users without entering password using FIDO Universal Authentication Framework.

@@ -1,17 +1,13 @@
# Authentication and Authorization


The authentication and authorization features introduce how you can obtain access tokens using OAuth 2.0, and authenticate users using the FIDO framework.

You can use the following authentication and authorization features in your .NET applications:
Copy link
Contributor

Choose a reason for hiding this comment

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

How about removing authorization from this sentence?

Suggested change
You can use the following authentication and authorization features in your .NET applications:
You can use the following authentication features in your .NET applications:

Copy link
Author

Choose a reason for hiding this comment

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

changes are done, kindly review

@TizenDocsBot
Copy link
Collaborator

checkout the webpage https://docs1.stg.tizen.org/staging/1206

@TizenDocsBot
Copy link
Collaborator

Check Broken Link: Not found any broken link

@mijin85cho
Copy link
Contributor

Hello, @chauhan321
Would you please check my comment?

mijin85cho
The enhancing is more than my expectation. As the introducing, we don't need to use heavy sentences here.

How about below?

You can authenticate users without entering password using FIDO Universal Authentication Framework.

@TizenDocsBot
Copy link
Collaborator

checkout the webpage https://docs1.stg.tizen.org/staging/1206

@TizenDocsBot
Copy link
Collaborator

Check Broken Link: Not found any broken link

@chauhan321
Copy link
Author

Hello, @chauhan321
Would you please check my comment?

mijin85cho
The enhancing is more than my expectation. As the introducing, we don't need to use heavy sentences here.
How about below?
You can authenticate users without entering password using FIDO Universal Authentication Framework.

Done

Copy link
Contributor

@mijin85cho mijin85cho left a comment

Choose a reason for hiding this comment

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

Thanks for the updates

@@ -186,7 +186,6 @@
#### Authentication and Authorization
##### [Overview](/application/dotnet/guides/personal/authentication.md)
##### [FIDO Universal Authentication Framework](/application/dotnet/guides/personal/fido.md)
##### [OAuth 2.0](/application/dotnet/guides/personal/oauth.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't recommend creating child nodes when there is only one child.

Suggestion:

...
### Personal Data
#### [Overview](/application/dotnet/guides/personal/overview.md)
#### [Account Management](/application/dotnet/guides/personal/account.md)
#### [Synchronization Management](/application/dotnet/guides/personal/data-sync.md)
#### [FIDO Universal Authentication Framework](/application/dotnet/guides/personal/fido.md)
#### [Calendar](/application/dotnet/guides/personal/calendar.md)
...

Copy link
Author

Choose a reason for hiding this comment

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

Done

@@ -15,7 +15,7 @@ You can use the following personal data features in your .NET applications:

- [Authentication and Authorization](authentication.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you change this item as follow?

-   [FIDO Universal Authentication Framework](fido.md)

    You can use the FIDO Universal Authentication Framework to authenticate users. FIDO covers password-less authentications, such as fingerprint, iris, and voice.

We don't recommend creating child nodes when there is only one child.
Authentication and Authorization has only one child, fido.md can be a child node of Personal Data.

Copy link
Author

Choose a reason for hiding this comment

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

Done

@@ -1,17 +1,13 @@
# Authentication and Authorization
Copy link
Contributor

Choose a reason for hiding this comment

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

If you think this file, authentication.md, should be reused someday, you can leave this file.
Otherwise, please remove this file.

Copy link
Author

Choose a reason for hiding this comment

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

In the future, there are chances of redesigning of oauth 2.0. Then we may need to reuse this file again. lets keep this file for now.

@TizenDocsBot
Copy link
Collaborator

checkout the webpage https://docs1.stg.tizen.org/staging/1206

@TizenDocsBot
Copy link
Collaborator

Check Broken Link: Not found any broken link

@duchuyta
Copy link
Collaborator

Rerun bot

@duchuyta duchuyta closed this Aug 31, 2020
@duchuyta duchuyta reopened this Aug 31, 2020
@TizenDocsBot
Copy link
Collaborator

checkout the webpage https://docs1.stg.tizen.org/staging/1206

@TizenDocsBot
Copy link
Collaborator

Check Broken Link: Not found any broken link

@chauhan321
Copy link
Author

chauhan321 commented Oct 8, 2020

Hello @journey2w , changes are done. Kindly review

@journey2w journey2w force-pushed the master branch 3 times, most recently from 81a8739 to b4510fa Compare December 2, 2020 10:26
@annie-samsung
Copy link
Contributor

@mijin85cho could you suggest what needs to be done with this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants