github.com/apremalal/vamps-core@v1.0.1-0.20161221121535-d430b56ec174/server/webapps/apieditor/spec-files/security.yaml (about)

     1  swagger: '2.0'
     2  info:
     3    version: 1.0.9-abcd
     4    title: Swagger Sample API
     5    description: A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification
     6    termsOfService: http://helloreverb.com/terms/
     7    contact:
     8      name: swagger api team
     9      url: http://swagger.io
    10    license:
    11      name: Creative Commons 4.0 International
    12      url: http://creativecommons.org/licenses/by/4.0/
    13  basePath: /v1
    14  schemes:
    15    - http
    16    - https
    17  consumes:
    18    - application/json
    19  produces:
    20    - application/json
    21    - application/xml
    22  security:
    23    - githubAccessCode:
    24      - user
    25      - user:email
    26      - user:follow
    27      - public_repo
    28      - repo
    29      - repo_deployment
    30      - repo:status
    31      - delete_repo
    32      - notifications
    33      - gist
    34      - read:repo_hook
    35      - write:repo_hook
    36      - admin:repo_hook
    37      - read:org
    38      - write:org
    39      - admin:org
    40      - read:public_key
    41      - write:public_key
    42      - admin:public_key
    43    - petstoreImplicit:
    44      - user
    45      - user:email
    46      - user:follow
    47      - public_repo
    48      - repo
    49      - repo_deployment
    50      - repo:status
    51      - delete_repo
    52      - notifications
    53      - gist
    54      - read:repo_hook
    55      - write:repo_hook
    56      - admin:repo_hook
    57      - read:org
    58      - write:org
    59      - admin:org
    60      - read:public_key
    61      - write:public_key
    62      - admin:public_key
    63    - internalApiKey: []
    64  paths:
    65    /pets/{id}:
    66      get:
    67        parameters:
    68        - name: id
    69          in: path
    70          description: ID of pet to use
    71          required: true
    72          type: array
    73          items:
    74            type: string
    75          collectionFormat: csv
    76        description: Returns pets based on ID
    77        summary: Find pets by ID
    78        operationId: getPetsById
    79        security:
    80          - githubAccessCode:
    81              - user
    82          - internalApiKey: []
    83        produces:
    84          - application/json
    85          - text/html
    86        responses:
    87          "200":
    88            description: pet response
    89            schema:
    90              type: array
    91              items:
    92                $ref: '#/definitions/Pet'
    93          default:
    94            description: error payload
    95            schema:
    96              $ref: '#/definitions/ErrorModel'
    97  securityDefinitions:
    98    githubAccessCode:
    99      type: oauth2
   100      scopes:
   101        user: Grants read/write access to profile info only. Note that this scope includes user:email and user:follow.
   102        user:email: Grants read access to a user’s email addresses.
   103        user:follow: Grants access to follow or unfollow other users.
   104        public_repo: Grants read/write access to code, commit statuses, and deployment statuses for public repositories and organizations.
   105        repo: Grants read/write access to code, commit statuses, and deployment statuses for public and private repositories and organizations.
   106        repo_deployment: Grants access to deployment statuses for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, without granting access to the code.
   107        repo:status: Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses without granting access to the code.
   108        delete_repo: Grants access to delete adminable repositories.
   109        notifications: Grants read access to a user’s notifications. repo also provides this access.
   110        gist: Grants write access to gists.
   111        read:repo_hook: Grants read and ping access to hooks in public or private repositories.
   112        write:repo_hook: Grants read, write, and ping access to hooks in public or private repositories.
   113        admin:repo_hook: Grants read, write, ping, and delete access to hooks in public or private repositories.
   114        read:org: Read-only access to organization, teams, and membership.
   115        write:org: Publicize and unpublicize organization membership.
   116        admin:org: Fully manage organization, teams, and memberships.
   117        read:public_key: List and view details for public keys.
   118        write:public_key: Create, list, and view details for public keys.
   119        admin:public_key: Fully manage public keys.
   120      flow: accessCode
   121      authorizationUrl: https://github.com/login/oauth/authorize
   122      tokenUrl: https://github.com/login/oauth/access_token
   123    petstoreImplicit:
   124      type: oauth2
   125      scopes:
   126        user: Grants read/write access to profile info only. Note that this scope includes user:email and user:follow.
   127        user:email: Grants read access to a user’s email addresses.
   128        user:follow: Grants access to follow or unfollow other users.
   129        public_repo: Grants read/write access to code, commit statuses, and deployment statuses for public repositories and organizations.
   130        repo: Grants read/write access to code, commit statuses, and deployment statuses for public and private repositories and organizations.
   131        repo_deployment: Grants access to deployment statuses for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, without granting access to the code.
   132        repo:status: Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses without granting access to the code.
   133        delete_repo: Grants access to delete adminable repositories.
   134        notifications: Grants read access to a user’s notifications. repo also provides this access.
   135        gist: Grants write access to gists.
   136        read:repo_hook: Grants read and ping access to hooks in public or private repositories.
   137        write:repo_hook: Grants read, write, and ping access to hooks in public or private repositories.
   138        admin:repo_hook: Grants read, write, ping, and delete access to hooks in public or private repositories.
   139        read:org: Read-only access to organization, teams, and membership.
   140        write:org: Publicize and unpublicize organization membership.
   141        admin:org: Fully manage organization, teams, and memberships.
   142        read:public_key: List and view details for public keys.
   143        write:public_key: Create, list, and view details for public keys.
   144        admin:public_key: Fully manage public keys.
   145      flow: implicit
   146      authorizationUrl: http://petstore.swagger.io/oauth/dialog
   147    internalApiKey:
   148      type: apiKey
   149      in: header
   150      name: api_key
   151  definitions:
   152    Pet:
   153      type: object
   154      required:
   155        - name
   156      properties:
   157        name:
   158          type: string
   159        tag:
   160          type: string
   161    ErrorModel:
   162      type: object
   163      required:
   164        - code
   165        - message
   166      properties:
   167        code:
   168          type: integer
   169          format: int32
   170        message:
   171          type: string