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

     1  ---
     2  paths:
     3    service-edge-router-policies:
     4      get:
     5        summary: List service edge router policies
     6        description: |
     7          Retrieves a list of service edge router policy resources; supports filtering, sorting, and pagination. Requires admin access.
     8        security:
     9          - ztSession: [ ]
    10        tags:
    11          - Service Edge Router Policy
    12        operationId: listServiceEdgeRouterPolicies
    13        parameters:
    14          - $ref: '../shared/parameters.yml#/limit'
    15          - $ref: '../shared/parameters.yml#/offset'
    16          - $ref: '../shared/parameters.yml#/filter'
    17        responses:
    18          '200':
    19            $ref: '#/responses/listServiceEdgeRouterPolicies'
    20          '401':
    21            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    22          '400':
    23            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    24      post:
    25        summary: Create a service edge router policy resource
    26        description: Create a service edge router policy resource. Requires admin access.
    27        security:
    28          - ztSession: [ ]
    29        tags:
    30          - Service Edge Router Policy
    31        operationId: createServiceEdgeRouterPolicy
    32        parameters:
    33          - name: policy
    34            in: body
    35            required: true
    36            description: A service edge router policy to create
    37            schema:
    38              $ref: '#/definitions/serviceEdgeRouterPolicyCreate'
    39        responses:
    40          '201':
    41            $ref: '../shared/standard-responses.yml#/responses/createResponse'
    42          '400':
    43            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    44          '401':
    45            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    46    service-edge-router-policies-id:
    47      parameters:
    48        - $ref: '../shared/parameters.yml#/id'
    49      get:
    50        summary: Retrieves a single service edge policy
    51        description: Retrieves a single service edge policy by id. Requires admin access.
    52        security:
    53          - ztSession: [ ]
    54        tags:
    55          - Service Edge Router Policy
    56        operationId: detailServiceEdgeRouterPolicy
    57        responses:
    58          '200':
    59            $ref: '#/responses/detailServiceEdgePolicy'
    60          '404':
    61            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    62          '401':
    63            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    64      put:
    65        summary: Update all fields on a service edge policy
    66        description: Update all fields on a service edge policy by id. Requires admin access.
    67        security:
    68          - ztSession: [ ]
    69        tags:
    70          - Service Edge Router Policy
    71        operationId: updateServiceEdgeRouterPolicy
    72        parameters:
    73          - name: policy
    74            in: body
    75            required: true
    76            description: A service edge router policy update object
    77            schema:
    78              $ref: '#/definitions/serviceEdgeRouterPolicyUpdate'
    79        responses:
    80          '200':
    81            $ref: '../shared/standard-responses.yml#/responses/updateResponse'
    82          '400':
    83            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    84          '404':
    85            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    86          '401':
    87            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    88      patch:
    89        summary: Update the supplied fields on a service edge policy
    90        description: Update the supplied fields on a service edge policy. Requires admin access.
    91        security:
    92          - ztSession: [ ]
    93        tags:
    94          - Service Edge Router Policy
    95        operationId: patchServiceEdgeRouterPolicy
    96        parameters:
    97          - name: policy
    98            in: body
    99            required: true
   100            description: A service edge router policy patch object
   101            schema:
   102              $ref: '#/definitions/serviceEdgeRouterPolicyPatch'
   103        responses:
   104          '200':
   105            $ref: '../shared/standard-responses.yml#/responses/patchResponse'
   106          '400':
   107            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   108          '404':
   109            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   110          '401':
   111            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   112      delete:
   113        summary: Delete a service edge policy
   114        description: Delete a service edge policy by id. Requires admin access.
   115        security:
   116          - ztSession: [ ]
   117        tags:
   118          - Service Edge Router Policy
   119        operationId: deleteServiceEdgeRouterPolicy
   120        responses:
   121          '200':
   122            $ref: '../shared/standard-responses.yml#/responses/deleteResponse'
   123          '400':
   124            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   125          '401':
   126            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   127          '409':
   128            $ref: '../shared/standard-responses.yml#/responses/cannotDeleteReferencedResourceResponse'
   129    service-edge-router-policies-id-edge-routers:
   130      parameters:
   131        - $ref: '../shared/parameters.yml#/id'
   132      get:
   133        summary: List the edge routers that a service edge router policy applies to
   134        description: List the edge routers that a service edge router policy applies to
   135        security:
   136          - ztSession: [ ]
   137        tags:
   138          - Service Edge Router Policy
   139        operationId: listServiceEdgeRouterPolicyEdgeRouters
   140        responses:
   141          '200':
   142            $ref: 'edge-routers.yml#/responses/listEdgeRouters'
   143          '404':
   144            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   145          '401':
   146            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   147    service-edge-router-policies-id-services:
   148      parameters:
   149        - $ref: '../shared/parameters.yml#/id'
   150      get:
   151        summary: List the services that a service edge router policy applies to
   152        description: List the services that a service edge router policy applies to
   153        security:
   154          - ztSession: [ ]
   155        tags:
   156          - Service Edge Router Policy
   157        operationId: listServiceEdgeRouterPolicyServices
   158        responses:
   159          '200':
   160            $ref: '../shared/services.yml#/responses/listServices'
   161          '404':
   162            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   163          '401':
   164            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   165  
   166  responses:
   167    listServiceEdgeRouterPolicies:
   168      description: A list of service edge router policies
   169      schema:
   170        $ref: '#/definitions/listServiceEdgeRouterPoliciesEnvelope'
   171    detailServiceEdgePolicy:
   172      description: A single service edge router policy
   173      schema:
   174        $ref: '#/definitions/detailServiceEdgePolicyEnvelope'
   175  
   176  definitions:
   177    listServiceEdgeRouterPoliciesEnvelope:
   178      type: object
   179      required:
   180        - meta
   181        - data
   182      properties:
   183        meta:
   184          $ref: '../shared/standard-responses.yml#/definitions/meta'
   185        data:
   186          $ref: '#/definitions/serviceEdgeRouterPolicyList'
   187    detailServiceEdgePolicyEnvelope:
   188      type: object
   189      required:
   190        - meta
   191        - data
   192      properties:
   193        meta:
   194          $ref: '../shared/standard-responses.yml#/definitions/meta'
   195        data:
   196          $ref: '#/definitions/serviceEdgeRouterPolicyDetail'
   197    serviceEdgeRouterPolicyList:
   198      type: array
   199      items:
   200        $ref: '#/definitions/serviceEdgeRouterPolicyDetail'
   201    serviceEdgeRouterPolicyDetail:
   202      type: object
   203      allOf:
   204        - $ref: '../shared/base-entity.yml#/definitions/baseEntity'
   205        - type: object
   206          required:
   207            - name
   208            - semantic
   209            - edgeRouterRoles
   210            - edgeRouterRolesDisplay
   211            - serviceRoles
   212            - serviceRolesDisplay
   213          properties:
   214            name:
   215              type: string
   216            semantic:
   217              $ref: '../shared/base-entity.yml#/definitions/semantic'
   218            edgeRouterRoles:
   219              $ref: '../shared/base-entity.yml#/definitions/roles'
   220            edgeRouterRolesDisplay:
   221              $ref: '../shared/base-entity.yml#/definitions/namedRoles'
   222            serviceRoles:
   223              $ref: '../shared/base-entity.yml#/definitions/roles'
   224            serviceRolesDisplay:
   225              $ref: '../shared/base-entity.yml#/definitions/namedRoles'
   226    serviceEdgeRouterPolicyCreate:
   227      type: object
   228      required:
   229        - name
   230        - semantic
   231      properties:
   232        tags:
   233          $ref: '../shared/base-entity.yml#/definitions/tags'
   234        name:
   235          type: string
   236        semantic:
   237          $ref: '../shared/base-entity.yml#/definitions/semantic'
   238        edgeRouterRoles:
   239          $ref: '../shared/base-entity.yml#/definitions/roles'
   240        serviceRoles:
   241          $ref: '../shared/base-entity.yml#/definitions/roles'
   242    serviceEdgeRouterPolicyUpdate:
   243      type: object
   244      required:
   245        - name
   246        - semantic
   247      properties:
   248        tags:
   249          $ref: '../shared/base-entity.yml#/definitions/tags'
   250        name:
   251          type: string
   252        semantic:
   253          $ref: '../shared/base-entity.yml#/definitions/semantic'
   254        edgeRouterRoles:
   255          $ref: '../shared/base-entity.yml#/definitions/roles'
   256        serviceRoles:
   257          $ref: '../shared/base-entity.yml#/definitions/roles'
   258    serviceEdgeRouterPolicyPatch:
   259      type: object
   260      properties:
   261        tags:
   262          $ref: '../shared/base-entity.yml#/definitions/tags'
   263        name:
   264          type: string
   265        semantic:
   266          $ref: '../shared/base-entity.yml#/definitions/semantic'
   267        edgeRouterRoles:
   268          $ref: '../shared/base-entity.yml#/definitions/roles'
   269        serviceRoles:
   270          $ref: '../shared/base-entity.yml#/definitions/roles'