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

Authentication Framework #4

Merged
merged 1 commit into from
Oct 21, 2015
Merged

Authentication Framework #4

merged 1 commit into from
Oct 21, 2015

Conversation

kylef
Copy link
Member

@kylef kylef commented Sep 29, 2015

This pull request proposes an RFC for adding an authentication framework to the API Blueprint language.

It supersedes:

@kylef kylef added the draft label Sep 29, 2015
@kylef kylef mentioned this pull request Sep 29, 2015
1 task
resource groups, resources, actions or requests as authenticated.
Along with defining a framework for creating authentication schemes.

This RFC does not propose any specific authentication schemes, these are to be
Copy link
Contributor

Choose a reason for hiding this comment

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

Those?

@kylef kylef mentioned this pull request Oct 1, 2015
2 tasks
+ username: katie
```

You may also provide failure responses in anonymouse authentication schemes.
Copy link
Contributor

Choose a reason for hiding this comment

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

What is an anonymous authentication scheme?

Also, spelling: anonymous**e**

Copy link
Member Author

Choose a reason for hiding this comment

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

@danielgtaylor Anonymous compared to the named schemes defined in the "Authentication Scheme" section. Anonymous schemes are define in-line within other elements like resources/actions.

Does this make sense?

@danielgtaylor
Copy link
Contributor

Just the one question about anonymous authentication, otherwise LGTM! 👍

@rintcius
Copy link

What's the status of this proposal (ie when can we expect this feature to be available)?

Also, since this is the relevant PR wrt authentication, maybe good to close the other PR's to avoid confusion?
BTW https://docs.apiary.io/faq/authentication/ still refers to an outdated proposal.

@zdne
Copy link
Contributor

zdne commented Oct 21, 2015

I like it. Some qualifications are needed – for example how one can describe the schemes, or specify multiple responses – but as a draft it is solid. Going to merge it after I read the related PRs to verify this works as a framework.

zdne added a commit that referenced this pull request Oct 21, 2015
@zdne zdne merged commit 4998984 into master Oct 21, 2015
@zdne zdne deleted the kylef/authentication branch October 21, 2015 15:21
@kylef
Copy link
Member Author

kylef commented Oct 23, 2015

@zdne I think multiple responses should already be clear, there is a parameter within the Request inside Request Examples.

For a more complete example, you could use the following to show both a request without authentication and a request with authentication.

+ Response 200 (application/json)
    + Attributes
        + name: Kyle

+ Request
    + Authenticated (Basic)
        + username: kyle
        + password: b2952d03bda09cb5f63b0162fbbee77c
+ Response 200 (application/json)
    + Attributes
        + name: Kyle
        + email: `[email protected]`

Please let me know if it's not clear and I can amend.

+ username: kyle
+ password: b2952d03bda09cb5f63b0162fbbee77c
+ (Passphrase)
```
Copy link
Contributor

Choose a reason for hiding this comment

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

We might want add another example here to show a simple version of this.

+ Authenticated (enum[Basic, Passphrase])

@pksunkara
Copy link
Contributor

# Passphrase (Basic)
+ username: kyle
+ password: b2952d03bda09cb5f63b0162fbbee77c

+ Response 203 (application/json)

        {}

I am not sure where exactly you will be putting the description in the above example. I want to describe the Passphrase Authentication Scheme. Where do I do that?

@pksunkara
Copy link
Contributor

@kylef My review finished.

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

Successfully merging this pull request may close these issues.

5 participants