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

     1  ---
     2  paths:
     3    edge-router-policies:
     4      get:
     5        summary: List edge router policies
     6        description: |
     7          Retrieves a list of edge router policy resources; supports filtering, sorting, and pagination. Requires admin access.
     8        security:
     9          - ztSession: [ ]
    10        tags:
    11          - Edge Router Policy
    12        operationId: listEdgeRouterPolicies
    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/listEdgeRouterPolicies'
    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 an edge router policy resource
    26        description: Create an edge router policy resource. Requires admin access.
    27        security:
    28          - ztSession: [ ]
    29        tags:
    30          - Edge Router Policy
    31        operationId: createEdgeRouterPolicy
    32        parameters:
    33          - name: policy
    34            in: body
    35            required: true
    36            description: An edge router policy to create
    37            schema:
    38              $ref: '#/definitions/edgeRouterPolicyCreate'
    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    edge-router-policies-id:
    47      parameters:
    48        - $ref: '../shared/parameters.yml#/id'
    49      get:
    50        summary: Retrieves a single edge router policy
    51        description: Retrieves a single edge router policy by id. Requires admin access.
    52        security:
    53          - ztSession: [ ]
    54        tags:
    55          - Edge Router Policy
    56        operationId: detailEdgeRouterPolicy
    57        responses:
    58          '200':
    59            $ref: '#/responses/detailEdgeRouterPolicy'
    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 an edge router policy
    66        description: Update all fields on an edge router policy by id. Requires admin access.
    67        security:
    68          - ztSession: [ ]
    69        tags:
    70          - Edge Router Policy
    71        operationId: updateEdgeRouterPolicy
    72        parameters:
    73          - name: policy
    74            in: body
    75            required: true
    76            description: An edge router policy update object
    77            schema:
    78              $ref: '#/definitions/edgeRouterPolicyUpdate'
    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 an edge router policy
    90        description: Update the supplied fields on an edge router policy. Requires admin access.
    91        security:
    92          - ztSession: [ ]
    93        tags:
    94          - Edge Router Policy
    95        operationId: patchEdgeRouterPolicy
    96        parameters:
    97          - name: policy
    98            in: body
    99            required: true
   100            description: An edge router policy patch object
   101            schema:
   102              $ref: '#/definitions/edgeRouterPolicyPatch'
   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 an edge router policy
   114        description: Delete an edge router policy by id. Requires admin access.
   115        security:
   116          - ztSession: [ ]
   117        tags:
   118          - Edge Router Policy
   119        operationId: deleteEdgeRouterPolicy
   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    edge-router-policies-id-edge-routers:
   130      parameters:
   131        - $ref: '../shared/parameters.yml#/id'
   132      get:
   133        summary: List edge routers a policy affects
   134        description: |
   135          Retrieves a list of edge routers an edge router policy resources affects; supports filtering, sorting, and pagination. Requires admin access.
   136        security:
   137          - ztSession: [ ]
   138        tags:
   139          - Edge Router Policy
   140        operationId: listEdgeRouterPolicyEdgeRouters
   141        responses:
   142          '200':
   143            $ref: 'edge-routers.yml#/responses/listEdgeRouters'
   144          '404':
   145            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   146          '401':
   147            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   148    edge-router-policies-id-identities:
   149      parameters:
   150        - $ref: '../shared/parameters.yml#/id'
   151      get:
   152        summary: List identities an edge router policy affects
   153        description: |
   154          Retrieves a list of identities an edge router policy resources affects; supports filtering, sorting, and pagination. Requires admin access.
   155        security:
   156          - ztSession: [ ]
   157        tags:
   158          - Edge Router Policy
   159        operationId: listEdgeRouterPolicyIdentities
   160        responses:
   161          '200':
   162            $ref: 'identities.yml#/responses/listIdentities'
   163          '404':
   164            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   165          '401':
   166            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   167  
   168  responses:
   169    listEdgeRouterPolicies:
   170      description: A list of edge router policies
   171      schema:
   172        $ref: '#/definitions/listEdgeRouterPoliciesEnvelope'
   173    detailEdgeRouterPolicy:
   174      description: A single edge router policy
   175      schema:
   176        $ref: '#/definitions/detailEdgeRouterPolicyEnvelope'
   177  
   178  definitions:
   179    listEdgeRouterPoliciesEnvelope:
   180      type: object
   181      required:
   182        - meta
   183        - data
   184      properties:
   185        meta:
   186          $ref: '../shared/standard-responses.yml#/definitions/meta'
   187        data:
   188          $ref: '#/definitions/edgeRouterPolicyList'
   189    detailEdgeRouterPolicyEnvelope:
   190      type: object
   191      required:
   192        - meta
   193        - data
   194      properties:
   195        meta:
   196          $ref: '../shared/standard-responses.yml#/definitions/meta'
   197        data:
   198          $ref: '#/definitions/edgeRouterPolicyDetail'
   199    edgeRouterPolicyCreate:
   200      required:
   201        - name
   202        - semantic
   203      properties:
   204        name:
   205          type: string
   206        semantic:
   207          $ref: '../shared/base-entity.yml#/definitions/semantic'
   208        edgeRouterRoles:
   209          $ref: '../shared/base-entity.yml#/definitions/roles'
   210        identityRoles:
   211          $ref: '../shared/base-entity.yml#/definitions/roles'
   212        tags:
   213          $ref: '../shared/base-entity.yml#/definitions/tags'
   214    edgeRouterPolicyUpdate:
   215      required:
   216        - name
   217        - semantic
   218      properties:
   219        name:
   220          type: string
   221        semantic:
   222          $ref: '../shared/base-entity.yml#/definitions/semantic'
   223        edgeRouterRoles:
   224          $ref: '../shared/base-entity.yml#/definitions/roles'
   225        identityRoles:
   226          $ref: '../shared/base-entity.yml#/definitions/roles'
   227        tags:
   228          $ref: '../shared/base-entity.yml#/definitions/tags'
   229    edgeRouterPolicyPatch:
   230      properties:
   231        name:
   232          type: string
   233        semantic:
   234          $ref: '../shared/base-entity.yml#/definitions/semantic'
   235        edgeRouterRoles:
   236          $ref: '../shared/base-entity.yml#/definitions/roles'
   237        identityRoles:
   238          $ref: '../shared/base-entity.yml#/definitions/roles'
   239        tags:
   240          $ref: '../shared/base-entity.yml#/definitions/tags'
   241    edgeRouterPolicyList:
   242      type: array
   243      items:
   244        $ref: '#/definitions/edgeRouterPolicyDetail'
   245    edgeRouterPolicyDetail:
   246      type: object
   247      allOf:
   248        - $ref: '../shared/base-entity.yml#/definitions/baseEntity'
   249        - type: object
   250          required:
   251            - name
   252            - semantic
   253            - edgeRouterRoles
   254            - edgeRouterRolesDisplay
   255            - identityRoles
   256            - identityRolesDisplay
   257            - isSystem
   258          properties:
   259            name:
   260              type: string
   261            semantic:
   262              $ref: '../shared/base-entity.yml#/definitions/semantic'
   263            edgeRouterRoles:
   264              $ref: '../shared/base-entity.yml#/definitions/roles'
   265            edgeRouterRolesDisplay:
   266              $ref: '../shared/base-entity.yml#/definitions/namedRoles'
   267            identityRoles:
   268              $ref: '../shared/base-entity.yml#/definitions/roles'
   269            identityRolesDisplay:
   270              $ref: '../shared/base-entity.yml#/definitions/namedRoles'
   271            isSystem:
   272              type: boolean