github.com/thetreep/go-swagger@v0.0.0-20240223100711-35af64f14f01/fixtures/bugs/2919/edge-api/management/services.yml (about)

     1  ---
     2  paths:
     3    services:
     4      get:
     5        summary: List services
     6        description: |
     7          Retrieves a list of config resources; supports filtering, sorting, and pagination. Requires admin access.
     8        security:
     9          - ztSession: [ ]
    10        tags:
    11          - Service
    12        operationId: listServices
    13        parameters:
    14          - $ref: '../shared/parameters.yml#/limit'
    15          - $ref: '../shared/parameters.yml#/offset'
    16          - $ref: '../shared/parameters.yml#/filter'
    17          - $ref: '../shared/parameters.yml#/roleFilter'
    18          - $ref: '../shared/parameters.yml#/roleSemantic'
    19        responses:
    20          '200':
    21            $ref: '../shared/services.yml#/responses/listServices'
    22          '401':
    23            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    24          '400':
    25            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    26      post:
    27        summary: Create a services resource
    28        description: Create a services resource. Requires admin access.
    29        security:
    30          - ztSession: [ ]
    31        tags:
    32          - Service
    33        operationId: createService
    34        parameters:
    35          - name: service
    36            in: body
    37            required: true
    38            description: A service to create
    39            schema:
    40              $ref: '#/definitions/serviceCreate'
    41        responses:
    42          '201':
    43            $ref: '../shared/standard-responses.yml#/responses/createResponse'
    44          '400':
    45            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    46          '401':
    47            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    48    services-id:
    49      parameters:
    50        - $ref: '../shared/parameters.yml#/id'
    51      get:
    52        summary: Retrieves a single service
    53        description: Retrieves a single service by id. Requires admin access.
    54        security:
    55          - ztSession: [ ]
    56        tags:
    57          - Service
    58        operationId: detailService
    59        responses:
    60          '200':
    61            $ref: '../shared/services.yml#/responses/detailService'
    62          '404':
    63            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    64          '401':
    65            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    66      put:
    67        summary: Update all fields on a service
    68        description: Update all fields on a service by id. Requires admin access.
    69        security:
    70          - ztSession: [ ]
    71        tags:
    72          - Service
    73        operationId: updateService
    74        parameters:
    75          - name: service
    76            in: body
    77            required: true
    78            description: A service update object
    79            schema:
    80              $ref: '#/definitions/serviceUpdate'
    81        responses:
    82          '200':
    83            $ref: '../shared/standard-responses.yml#/responses/updateResponse'
    84          '400':
    85            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    86          '404':
    87            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    88          '401':
    89            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    90      patch:
    91        summary: Update the supplied fields on a service
    92        description: Update the supplied fields on a service. Requires admin access.
    93        security:
    94          - ztSession: [ ]
    95        tags:
    96          - Service
    97        operationId: patchService
    98        parameters:
    99          - name: service
   100            in: body
   101            required: true
   102            description: A service patch object
   103            schema:
   104              $ref: '#/definitions/servicePatch'
   105        responses:
   106          '200':
   107            $ref: '../shared/standard-responses.yml#/responses/patchResponse'
   108          '400':
   109            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   110          '404':
   111            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   112          '401':
   113            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   114      delete:
   115        summary: Delete a service
   116        description: Delete a service by id. Requires admin access.
   117        security:
   118          - ztSession: [ ]
   119        tags:
   120          - Service
   121        operationId: deleteService
   122        responses:
   123          '200':
   124            $ref: '../shared/standard-responses.yml#/responses/deleteResponse'
   125          '400':
   126            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   127          '401':
   128            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   129          '409':
   130            $ref: '../shared/standard-responses.yml#/responses/cannotDeleteReferencedResourceResponse'
   131    services-id-configs:
   132      parameters:
   133        - $ref: '../shared/parameters.yml#/id'
   134      get:
   135        summary: List configs associated to a specific service
   136        description: |
   137          Retrieves a list of config resources associated to a specific service; supports filtering, sorting, and pagination. Requires admin access.
   138        security:
   139          - ztSession: [ ]
   140        tags:
   141          - Service
   142        operationId: listServiceConfig
   143        parameters:
   144          - $ref: '../shared/parameters.yml#/limit'
   145          - $ref: '../shared/parameters.yml#/offset'
   146          - $ref: '../shared/parameters.yml#/filter'
   147        responses:
   148          '200':
   149            $ref: 'configs.yml#/responses/listConfigs'
   150          '401':
   151            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   152          '400':
   153            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   154    services-id-service-edge-router-policies:
   155      parameters:
   156        - $ref: '../shared/parameters.yml#/id'
   157      get:
   158        summary: List service edge router policies that affect a specific service
   159        description: |
   160          Retrieves a list of service edge router policy resources that affect a specific service; supports filtering, sorting, and pagination. Requires admin access.
   161        security:
   162          - ztSession: [ ]
   163        tags:
   164          - Service
   165        operationId: listServiceServiceEdgeRouterPolicies
   166        parameters:
   167          - $ref: '../shared/parameters.yml#/limit'
   168          - $ref: '../shared/parameters.yml#/offset'
   169          - $ref: '../shared/parameters.yml#/filter'
   170        responses:
   171          '200':
   172            $ref: 'service-edge-router-policies.yml#/responses/listServiceEdgeRouterPolicies'
   173          '401':
   174            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   175          '400':
   176            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   177    services-id-service-policies:
   178      parameters:
   179        - $ref: '../shared/parameters.yml#/id'
   180      get:
   181        summary: List service policies that affect a specific service
   182        description: |
   183          Retrieves a list of service policy resources that affect specific service; supports filtering, sorting, and pagination. Requires admin access.
   184        security:
   185          - ztSession: [ ]
   186        tags:
   187          - Service
   188        operationId: listServiceServicePolicies
   189        parameters:
   190          - $ref: '../shared/parameters.yml#/limit'
   191          - $ref: '../shared/parameters.yml#/offset'
   192          - $ref: '../shared/parameters.yml#/filter'
   193        responses:
   194          '200':
   195            $ref: 'service-policies.yml#/responses/listServicePolicies'
   196          '401':
   197            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   198          '400':
   199            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   200  
   201    services-id-identities:
   202      parameters:
   203        - $ref: '../shared/parameters.yml#/id'
   204      get:
   205        summary: List identities with access
   206        description: |
   207          Retrieves a list of identities that have access to this service. Supports filtering, sorting, and pagination. Requires admin access.
   208        security:
   209          - ztSession: [ ]
   210        tags:
   211          - Service
   212        operationId: listServiceIdentities
   213        parameters:
   214          - $ref: '../shared/parameters.yml#/limit'
   215          - $ref: '../shared/parameters.yml#/offset'
   216          - $ref: '../shared/parameters.yml#/filter'
   217        responses:
   218          '200':
   219            $ref: 'identities.yml#/responses/listIdentities'
   220          '401':
   221            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   222          '400':
   223            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   224  
   225    services-id-edge-routers:
   226      parameters:
   227        - $ref: '../shared/parameters.yml#/id'
   228      get:
   229        summary: List accessible edge-routers
   230        description: |
   231          Retrieves a list of edge-routers that may be used to access the given service. Supports filtering, sorting, and pagination. Requires admin access.
   232        security:
   233          - ztSession: [ ]
   234        tags:
   235          - Service
   236        operationId: listServiceEdgeRouters
   237        parameters:
   238          - $ref: '../shared/parameters.yml#/limit'
   239          - $ref: '../shared/parameters.yml#/offset'
   240          - $ref: '../shared/parameters.yml#/filter'
   241        responses:
   242          '200':
   243            $ref: 'edge-routers.yml#/responses/listEdgeRouters'
   244          '401':
   245            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   246          '400':
   247            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   248  
   249    services-id-terminators:
   250      parameters:
   251        - $ref: '../shared/parameters.yml#/id'
   252      get:
   253        summary: List of terminators assigned to a service
   254        description: |
   255          Retrieves a list of terminator resources that are assigned specific service; supports filtering, sorting, and pagination.
   256        security:
   257          - ztSession: [ ]
   258        tags:
   259          - Service
   260        operationId: listServiceTerminators
   261        parameters:
   262          - $ref: '../shared/parameters.yml#/limit'
   263          - $ref: '../shared/parameters.yml#/offset'
   264          - $ref: '../shared/parameters.yml#/filter'
   265        responses:
   266          '200':
   267            $ref: 'terminators.yml#/responses/listTerminators'
   268          '401':
   269            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   270          '400':
   271            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   272  
   273  definitions:
   274    serviceCreate:
   275      type: object
   276      required:
   277        - name
   278        - encryptionRequired
   279      properties:
   280        name:
   281          type: string
   282        terminatorStrategy:
   283          type: string
   284        roleAttributes:
   285          type: array
   286          items:
   287            type: string
   288        configs:
   289          type: array
   290          items:
   291            type: string
   292        encryptionRequired:
   293          type: boolean
   294          description: Describes whether connections must support end-to-end encryption on both sides of the connection.
   295        tags:
   296          $ref: '../shared/base-entity.yml#/definitions/tags'
   297    serviceUpdate:
   298      type: object
   299      required:
   300        - name
   301      properties:
   302        name:
   303          type: string
   304        terminatorStrategy:
   305          type: string
   306        roleAttributes:
   307          type: array
   308          items:
   309            type: string
   310        configs:
   311          type: array
   312          items:
   313            type: string
   314        encryptionRequired:
   315          type: boolean
   316          description: Describes whether connections must support end-to-end encryption on both sides of the connection. Read-only property, set at create.
   317        tags:
   318          $ref: '../shared/base-entity.yml#/definitions/tags'
   319    servicePatch:
   320      type: object
   321      properties:
   322        name:
   323          type: string
   324        terminatorStrategy:
   325          type: string
   326        roleAttributes:
   327          type: array
   328          items:
   329            type: string
   330        configs:
   331          type: array
   332          items:
   333            type: string
   334        encryptionRequired:
   335          type: boolean
   336          description: Describes whether connections must support end-to-end encryption on both sides of the connection. Read-only property, set at create.
   337        tags:
   338          $ref: '../shared/base-entity.yml#/definitions/tags'