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

     1  ---
     2  paths:
     3    service-policies:
     4      get:
     5        summary: List service policies
     6        description: |
     7          Retrieves a list of service policy resources; supports filtering, sorting, and pagination. Requires admin access.
     8        security:
     9          - ztSession: [ ]
    10        tags:
    11          - Service Policy
    12        operationId: listServicePolicies
    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/listServicePolicies'
    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 policy resource
    26        description: Create a service policy resource. Requires admin access.
    27        security:
    28          - ztSession: [ ]
    29        tags:
    30          - Service Policy
    31        operationId: createServicePolicy
    32        parameters:
    33          - name: policy
    34            in: body
    35            required: true
    36            description: A service policy to create
    37            schema:
    38              $ref: '#/definitions/servicePolicyCreate'
    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-policies-id:
    47      parameters:
    48        - $ref: '../shared/parameters.yml#/id'
    49      get:
    50        summary: Retrieves a single service policy
    51        description: Retrieves a single service policy by id. Requires admin access.
    52        security:
    53          - ztSession: [ ]
    54        tags:
    55          - Service Policy
    56        operationId: detailServicePolicy
    57        responses:
    58          '200':
    59            $ref: '#/responses/detailServicePolicy'
    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 policy
    66        description: Update all fields on a service policy by id. Requires admin access.
    67        security:
    68          - ztSession: [ ]
    69        tags:
    70          - Service Policy
    71        operationId: updateServicePolicy
    72        parameters:
    73          - name: policy
    74            in: body
    75            required: true
    76            description: A service policy update object
    77            schema:
    78              $ref: '#/definitions/servicePolicyUpdate'
    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 policy
    90        description: Update the supplied fields on a service policy. Requires admin access.
    91        security:
    92          - ztSession: [ ]
    93        tags:
    94          - Service Policy
    95        operationId: patchServicePolicy
    96        parameters:
    97          - name: policy
    98            in: body
    99            required: true
   100            description: A service policy patch object
   101            schema:
   102              $ref: '#/definitions/servicePolicyPatch'
   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 policy
   114        description: Delete a service policy by id. Requires admin access.
   115        security:
   116          - ztSession: [ ]
   117        tags:
   118          - Service Policy
   119        operationId: deleteServicePolicy
   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-policies-id-identities:
   130      parameters:
   131        - $ref: '../shared/parameters.yml#/id'
   132      get:
   133        summary: List identities a service policy affects
   134        description: |
   135          Retrieves a list of identity resources that are affected by a service policy; supports filtering, sorting, and pagination. Requires admin access.
   136        security:
   137          - ztSession: [ ]
   138        tags:
   139          - Service Policy
   140        operationId: listServicePolicyIdentities
   141        parameters:
   142          - $ref: '../shared/parameters.yml#/limit'
   143          - $ref: '../shared/parameters.yml#/offset'
   144          - $ref: '../shared/parameters.yml#/filter'
   145        responses:
   146          '200':
   147            $ref: 'identities.yml#/responses/listIdentities'
   148          '401':
   149            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   150          '400':
   151            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   152  
   153    service-policies-id-services:
   154      parameters:
   155        - $ref: '../shared/parameters.yml#/id'
   156      get:
   157        summary: List services a service policy affects
   158        description: |
   159          Retrieves a list of service resources that are affected by a service policy; supports filtering, sorting, and pagination. Requires admin access.
   160        security:
   161          - ztSession: [ ]
   162        tags:
   163          - Service Policy
   164        operationId: listServicePolicyServices
   165        parameters:
   166          - $ref: '../shared/parameters.yml#/limit'
   167          - $ref: '../shared/parameters.yml#/offset'
   168          - $ref: '../shared/parameters.yml#/filter'
   169        responses:
   170          '200':
   171            $ref: '../shared/services.yml#/responses/listServices'
   172          '401':
   173            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   174          '400':
   175            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   176    service-policies-id-posture-checks:
   177      parameters:
   178        - $ref: '../shared/parameters.yml#/id'
   179      get:
   180        summary: List posture check a service policy includes
   181        description: |
   182          Retrieves a list of posture check resources that are affected by a service policy; supports filtering, sorting, and pagination. Requires admin access.
   183        security:
   184          - ztSession: [ ]
   185        tags:
   186          - Service Policy
   187        operationId: listServicePolicyPostureChecks
   188        parameters:
   189          - $ref: '../shared/parameters.yml#/limit'
   190          - $ref: '../shared/parameters.yml#/offset'
   191          - $ref: '../shared/parameters.yml#/filter'
   192        responses:
   193          '200':
   194            $ref: 'posture-checks.yml#/responses/listPostureChecks'
   195          '401':
   196            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   197          '400':
   198            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   199  
   200  responses:
   201    listServicePolicies:
   202      description: A list of service policies
   203      schema:
   204        $ref: '#/definitions/listServicePoliciesEnvelope'
   205    detailServicePolicy:
   206      description: A single service policy
   207      schema:
   208        $ref: '#/definitions/detailServicePolicyEnvelop'
   209  
   210  definitions:
   211    listServicePoliciesEnvelope:
   212      type: object
   213      required:
   214        - meta
   215        - data
   216      properties:
   217        meta:
   218          $ref: '../shared/standard-responses.yml#/definitions/meta'
   219        data:
   220          $ref: '#/definitions/servicePolicyList'
   221    detailServicePolicyEnvelop:
   222      type: object
   223      required:
   224        - meta
   225        - data
   226      properties:
   227        meta:
   228          $ref: '../shared/standard-responses.yml#/definitions/meta'
   229        data:
   230          $ref: '#/definitions/servicePolicyDetail'
   231    servicePolicyList:
   232      type: array
   233      items:
   234        $ref: '#/definitions/servicePolicyDetail'
   235    servicePolicyDetail:
   236      type: object
   237      allOf:
   238        - $ref: '../shared/base-entity.yml#/definitions/baseEntity'
   239        - type: object
   240          required:
   241            - name
   242            - type
   243            - semantic
   244            - serviceRoles
   245            - serviceRolesDisplay
   246            - identityRoles
   247            - identityRolesDisplay
   248            - postureCheckRoles
   249            - postureCheckRolesDisplay
   250          properties:
   251            name:
   252              type: string
   253            type:
   254              $ref: '../shared/base-entity.yml#/definitions/dialBind'
   255            semantic:
   256              $ref: '../shared/base-entity.yml#/definitions/semantic'
   257            serviceRoles:
   258              $ref: '../shared/base-entity.yml#/definitions/roles'
   259            serviceRolesDisplay:
   260              $ref: '../shared/base-entity.yml#/definitions/namedRoles'
   261            identityRoles:
   262              $ref: '../shared/base-entity.yml#/definitions/roles'
   263            identityRolesDisplay:
   264              $ref: '../shared/base-entity.yml#/definitions/namedRoles'
   265            postureCheckRoles:
   266              $ref: '../shared/base-entity.yml#/definitions/roles'
   267            postureCheckRolesDisplay:
   268              $ref: '../shared/base-entity.yml#/definitions/namedRoles'
   269    servicePolicyCreate:
   270      type: object
   271      required:
   272        - name
   273        - type
   274        - semantic
   275      properties:
   276        tags:
   277          $ref: '../shared/base-entity.yml#/definitions/tags'
   278        name:
   279          type: string
   280        type:
   281          $ref: '../shared/base-entity.yml#/definitions/dialBind'
   282        semantic:
   283          $ref: '../shared/base-entity.yml#/definitions/semantic'
   284        serviceRoles:
   285          $ref: '../shared/base-entity.yml#/definitions/roles'
   286        identityRoles:
   287          $ref: '../shared/base-entity.yml#/definitions/roles'
   288        postureCheckRoles:
   289          $ref: '../shared/base-entity.yml#/definitions/roles'
   290    servicePolicyUpdate:
   291      type: object
   292      required:
   293        - name
   294        - type
   295        - semantic
   296      properties:
   297        tags:
   298          $ref: '../shared/base-entity.yml#/definitions/tags'
   299        name:
   300          type: string
   301        type:
   302          $ref: '../shared/base-entity.yml#/definitions/dialBind'
   303        semantic:
   304          $ref: '../shared/base-entity.yml#/definitions/semantic'
   305        serviceRoles:
   306          $ref: '../shared/base-entity.yml#/definitions/roles'
   307        identityRoles:
   308          $ref: '../shared/base-entity.yml#/definitions/roles'
   309        postureCheckRoles:
   310          $ref: '../shared/base-entity.yml#/definitions/roles'
   311    servicePolicyPatch:
   312      type: object
   313      properties:
   314        tags:
   315          $ref: '../shared/base-entity.yml#/definitions/tags'
   316        name:
   317          type: string
   318        type:
   319          $ref: '../shared/base-entity.yml#/definitions/dialBind'
   320        semantic:
   321          $ref: '../shared/base-entity.yml#/definitions/semantic'
   322        serviceRoles:
   323          $ref: '../shared/base-entity.yml#/definitions/roles'
   324        identityRoles:
   325          $ref: '../shared/base-entity.yml#/definitions/roles'
   326        postureCheckRoles:
   327          $ref: '../shared/base-entity.yml#/definitions/roles'