github.com/go-swagger/go-swagger@v0.31.0/fixtures/bugs/2919/edge-api/client/sessions.yml (about)

     1  ---
     2  paths:
     3    sessions:
     4      get:
     5        summary: List sessions
     6        description: |
     7          Retrieves a list of active sessions resources; supports filtering, sorting, and pagination.
     8  
     9          Sessions are tied to an API session and are moved when an API session times out or logs out. Active sessions
    10          (i.e. Ziti SDK connected to an edge router) will keep the session and API session marked as active.
    11        security:
    12          - ztSession: [ ]
    13        tags:
    14          - Session
    15        operationId: listSessions
    16        parameters:
    17          - $ref: '../shared/parameters.yml#/limit'
    18          - $ref: '../shared/parameters.yml#/offset'
    19          - $ref: '../shared/parameters.yml#/filter'
    20        responses:
    21          '200':
    22            $ref: '../shared/sessions.yml#/responses/listSessions'
    23          '401':
    24            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    25          '400':
    26            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    27      post:
    28        summary: Create a session resource
    29        description: Create a session resource.
    30        security:
    31          - ztSession: [ ]
    32        tags:
    33          - Session
    34        operationId: createSession
    35        parameters:
    36          - name: session
    37            in: body
    38            required: true
    39            description: A session to create
    40            schema:
    41              $ref: '#/definitions/sessionCreate'
    42        responses:
    43          '201':
    44            $ref: '#/responses/sessionCreateResponse'
    45          '400':
    46            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    47          '401':
    48            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    49    sessions-id:
    50      parameters:
    51        - $ref: '../shared/parameters.yml#/id'
    52      get:
    53        summary: Retrieves a single session
    54        description: Retrieves a single session by id.
    55        security:
    56          - ztSession: [ ]
    57        tags:
    58          - Session
    59        operationId: detailSession
    60        responses:
    61          '200':
    62            $ref: '../shared/sessions.yml#/responses/detailSession'
    63          '404':
    64            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    65          '401':
    66            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    67      delete:
    68        summary: Delete a session
    69        description: Delete a session by id.
    70        security:
    71          - ztSession: [ ]
    72        tags:
    73          - Session
    74        operationId: deleteSession
    75        responses:
    76          '200':
    77            $ref: '../shared/standard-responses.yml#/responses/deleteResponse'
    78          '400':
    79            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    80          '401':
    81            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    82          '409':
    83            $ref: '../shared/standard-responses.yml#/responses/cannotDeleteReferencedResourceResponse'
    84  
    85  responses:
    86    sessionCreateResponse:
    87      description: The create request was successful and the resource has been added at the following location
    88      schema:
    89        $ref: '#/definitions/sessionCreateEnvelope'
    90  
    91  definitions:
    92    sessionCreateEnvelope:
    93      type: object
    94      properties:
    95        meta:
    96          $ref: '../shared/standard-responses.yml#/definitions/meta'
    97        data:
    98          $ref: '../shared/sessions.yml#/definitions/sessionDetail'
    99    sessionCreate:
   100      type: object
   101      properties:
   102        serviceId:
   103          type: string
   104        type:
   105          $ref: '../shared/base-entity.yml#/definitions/dialBind'
   106        tags:
   107          $ref: '../shared/base-entity.yml#/definitions/tags'