How to use RAML to describe an API using OAuth2

Question

I'm want to use RAML to describe an API using OAuth2

Does anyone have a solution or example I could use to compare with my own RAML for my api?

The close reason is prominently displayed above: Your question is off-topic since it requests an off-site resource. — njuffa, Jan 30 '16 at 18:35
@njuffa I asked for a solution and i got a popular answer! Is that not what this site is for? — Nikos, Feb 05 '16 at 18:38
Every community has rules. I don't make these rules. I just pointed out the particular rule your question ran afoul of, hoping to answer your question. — njuffa, Feb 05 '16 at 18:41

score 12 · Accepted Answer · answered Jan 15 '14 at 17:08

From https://github.com/raml-org/raml-spec/blob/master/08_security.md#declaration:

securitySchemes:
    - oauth_2_0:
        description: |
            Dropbox supports OAuth 2.0 for authenticating all API requests.
        type: OAuth 2.0
        describedBy:
            headers:
                Authorization:
                    description: |
                       Used to send a valid OAuth 2 access token. Do not use 
                       with the "access_token" query string parameter.
                    type: string
            queryParameters:
                access_token:
                    description: |
                       Used to send a valid OAuth 2 access token. Do not use together with 
                       the "Authorization" header
                    type: string
            responses:
                401:
                    description: |
                        Bad or expired token. This can happen if the user or Dropbox
                        revoked or expired an access token. To fix, you should re-
                        authenticate the user.
                403:
                    description: |
                        Bad OAuth request (wrong consumer key, bad nonce, expired
                        timestamp...). Unfortunately, re-authenticating the user won't help here.
        settings:
          authorizationUri: https://www.dropbox.com/1/oauth2/authorize
          accessTokenUri: https://api.dropbox.com/1/oauth2/token
          authorizationGrants: [ code, token ]

This is for raml 0.8 standard i suppose. what would a valid declaration look like for 1.0 ? — Andy Dufresne, Apr 07 '17 at 06:42

How to use RAML to describe an API using OAuth2

1 Answers1