github.com/go-swagger/go-swagger@v0.31.0/fixtures/bugs/2919/edge-api/management/posture-checks.yml (about)

     1  ---
     2  paths:
     3    posture-checks:
     4      get:
     5        summary: List a subset of posture checks
     6        description: |
     7          Retrieves a list of posture checks
     8        security:
     9          - ztSession: [ ]
    10        tags:
    11          - Posture Checks
    12        operationId: listPostureChecks
    13        produces:
    14          - application/json; charset=utf-8
    15        parameters:
    16          - $ref: '../shared/parameters.yml#/limit'
    17          - $ref: '../shared/parameters.yml#/offset'
    18          - $ref: '../shared/parameters.yml#/filter'
    19          - $ref: '../shared/parameters.yml#/roleFilter'
    20          - $ref: '../shared/parameters.yml#/roleSemantic'
    21        responses:
    22          '200':
    23            $ref: '#/responses/listPostureChecks'
    24          '401':
    25            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    26          '400':
    27            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    28      post:
    29        summary: Creates a Posture Checks
    30        description: Creates a Posture Checks
    31        security:
    32          - ztSession: [ ]
    33        tags:
    34          - Posture Checks
    35        operationId: createPostureCheck
    36        parameters:
    37          - name: postureCheck
    38            in: body
    39            required: true
    40            description: A Posture Check to create
    41            schema:
    42              $ref: '#/definitions/postureCheckCreate'
    43        responses:
    44          '201':
    45            $ref: '../shared/standard-responses.yml#/responses/createResponse'
    46          '400':
    47            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    48          '401':
    49            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    50    posture-checks-id:
    51      parameters:
    52        - $ref: '../shared/parameters.yml#/id'
    53      get:
    54        summary: Retrieves a single Posture Checks
    55        description: Retrieves a single Posture Checks by id
    56        security:
    57          - ztSession: [ ]
    58        tags:
    59          - Posture Checks
    60        operationId: detailPostureCheck
    61        responses:
    62          '200':
    63            $ref: '#/responses/detailPostureCheck'
    64          '404':
    65            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    66          '401':
    67            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    68      put:
    69        summary: Update all fields on a Posture Checks
    70        description: Update all fields on a Posture Checks by id
    71        security:
    72          - ztSession: [ ]
    73        tags:
    74          - Posture Checks
    75        operationId: updatePostureCheck
    76        parameters:
    77          - name: postureCheck
    78            in: body
    79            required: true
    80            description: A Posture Check update object
    81            schema:
    82              $ref: '#/definitions/postureCheckUpdate'
    83        responses:
    84          '200':
    85            $ref: '../shared/standard-responses.yml#/responses/updateResponse'
    86          '400':
    87            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    88          '404':
    89            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    90          '401':
    91            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    92      patch:
    93        summary: Update the supplied fields on a Posture Checks
    94        description: Update only the supplied fields on a Posture Checks by id
    95        security:
    96          - ztSession: [ ]
    97        tags:
    98          - Posture Checks
    99        operationId: patchPostureCheck
   100        parameters:
   101          - name: postureCheck
   102            in: body
   103            required: true
   104            description: A Posture Check patch object
   105            schema:
   106              $ref: '#/definitions/postureCheckPatch'
   107        responses:
   108          '200':
   109            $ref: '../shared/standard-responses.yml#/responses/patchResponse'
   110          '400':
   111            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   112          '404':
   113            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   114          '401':
   115            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   116      delete:
   117        summary: Deletes an Posture Checks
   118        description: Deletes and Posture Checks by id
   119        security:
   120          - ztSession: [ ]
   121        tags:
   122          - Posture Checks
   123        operationId: deletePostureCheck
   124        responses:
   125          '200':
   126            $ref: '../shared/standard-responses.yml#/responses/deleteResponse'
   127          '404':
   128            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   129          '403':
   130            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   131  
   132  responses:
   133    listPostureChecks:
   134      description: A list of posture checks
   135      schema:
   136        $ref: '#/definitions/listPostureCheckEnvelope'
   137    detailPostureCheck:
   138      description: Retrieves a singular posture check by id
   139      schema:
   140        $ref: '#/definitions/detailPostureCheckEnvelope'
   141  
   142  definitions:
   143    listPostureCheckEnvelope:
   144      type: object
   145      required:
   146        - meta
   147        - data
   148      properties:
   149        meta:
   150          $ref: '../shared/standard-responses.yml#/definitions/meta'
   151        data:
   152          #can't use postureCheckList as it will cause issues w/ the code generation as of 3/2021
   153          type: array
   154          items:
   155            $ref: '#/definitions/postureCheckDetail'
   156    detailPostureCheckEnvelope:
   157      type: object
   158      required:
   159        - meta
   160        - data
   161      properties:
   162        meta:
   163          $ref: '../shared/standard-responses.yml#/definitions/meta'
   164        data:
   165          $ref: '#/definitions/postureCheckDetail'
   166    operatingSystem:
   167      type: object
   168      required:
   169        - type
   170        - versions
   171      properties:
   172        type:
   173          $ref: '../shared/posture-checks.yml#/definitions/osType'
   174        versions:
   175          type: array
   176          items:
   177            type: string
   178    postureCheckDetail:
   179      type: object
   180      discriminator: typeId
   181      # base is duped here due to a bug in go-swagger that will try to embed a struct in an interface
   182      # see https://github.com/go-swagger/go-swagger/issues/2413
   183      required:
   184        - name
   185        - typeId
   186        - version
   187        - roleAttributes
   188        - id
   189        - createdAt
   190        - updatedAt
   191        - _links
   192        - tags
   193      properties:
   194        name:
   195          type: string
   196        typeId:
   197          type: string
   198        version:
   199          type: integer
   200        roleAttributes:
   201          $ref: '../shared/base-entity.yml#/definitions/attributes'
   202        id:
   203          type: string
   204        createdAt:
   205          type: string
   206          format: date-time
   207        updatedAt:
   208          type: string
   209          format: date-time
   210        _links:
   211          $ref: '../shared/base-entity.yml#/definitions/links'
   212        tags:
   213          $ref: '../shared/base-entity.yml#/definitions/tags'
   214    postureCheckCreate:
   215      type: object
   216      discriminator: typeId
   217      required:
   218        - name
   219        - typeId
   220      properties:
   221        name:
   222          type: string
   223        typeId:
   224          $ref: '../shared/posture-checks.yml#/definitions/postureCheckType'
   225        roleAttributes:
   226          $ref: '../shared/base-entity.yml#/definitions/attributes'
   227        tags:
   228          $ref: '../shared/base-entity.yml#/definitions/tags'
   229    postureCheckUpdate:
   230      type: object
   231      discriminator: typeId
   232      required:
   233        - name
   234      properties:
   235        name:
   236          type: string
   237        typeId:
   238          $ref: '../shared/posture-checks.yml#/definitions/postureCheckType'
   239        roleAttributes:
   240          $ref: '../shared/base-entity.yml#/definitions/attributes'
   241        tags:
   242          $ref: '../shared/base-entity.yml#/definitions/tags'
   243    postureCheckPatch:
   244      type: object
   245      discriminator: typeId
   246      required:
   247        - typeId
   248      properties:
   249        name:
   250          type: string
   251        typeId:
   252          $ref: '../shared/posture-checks.yml#/definitions/postureCheckType'
   253        roleAttributes:
   254          $ref: '../shared/base-entity.yml#/definitions/attributes'
   255        tags:
   256          $ref: '../shared/base-entity.yml#/definitions/tags'
   257  
   258  
   259    ###################################################################
   260    # Posture Check Operating System
   261    ###################################################################
   262    postureCheckOperatingSystemDetail:
   263      allOf:
   264        - $ref: '#/definitions/postureCheckDetail'
   265        - type: object
   266          required:
   267            - operatingSystems
   268          properties:
   269            operatingSystems:
   270              type: array
   271              items:
   272                $ref: '#/definitions/operatingSystem'
   273      x-class: "OS"
   274  
   275    postureCheckOperatingSystemCreate:
   276      allOf:
   277        - $ref: '#/definitions/postureCheckCreate'
   278        - type: object
   279          required:
   280            - operatingSystems
   281          properties:
   282            operatingSystems:
   283              type: array
   284              minItems: 1
   285              items:
   286                $ref: '#/definitions/operatingSystem'
   287      x-class: "OS"
   288    postureCheckOperatingSystemUpdate:
   289      allOf:
   290        - $ref: '#/definitions/postureCheckUpdate'
   291        - type: object
   292          required:
   293            - operatingSystems
   294          properties:
   295            operatingSystems:
   296              type: array
   297              minItems: 1
   298              items:
   299                $ref: '#/definitions/operatingSystem'
   300      x-class: "OS"
   301    postureCheckOperatingSystemPatch:
   302      allOf:
   303        - $ref: '#/definitions/postureCheckPatch'
   304        - type: object
   305          properties:
   306            operatingSystems:
   307              type: array
   308              minItems: 1
   309              items:
   310                $ref: '#/definitions/operatingSystem'
   311      x-class: "OS"
   312  
   313    ###################################################################
   314    # Posture Check Domain
   315    ###################################################################
   316    postureCheckDomainDetail:
   317      allOf:
   318        - $ref: '#/definitions/postureCheckDetail'
   319        - type: object
   320          required:
   321            - domains
   322          properties:
   323            domains:
   324              type: array
   325              minItems: 1
   326              items:
   327                type: string
   328      x-class: "DOMAIN"
   329  
   330    postureCheckDomainCreate:
   331      allOf:
   332        - $ref: '#/definitions/postureCheckCreate'
   333        - type: object
   334          required:
   335            - domains
   336          properties:
   337            domains:
   338              type: array
   339              minItems: 1
   340              items:
   341                type: string
   342      x-class: "DOMAIN"
   343  
   344    postureCheckDomainUpdate:
   345      allOf:
   346        - $ref: '#/definitions/postureCheckUpdate'
   347        - type: object
   348          required:
   349            - domains
   350          properties:
   351            domains:
   352              type: array
   353              minItems: 1
   354              items:
   355                type: string
   356      x-class: "DOMAIN"
   357  
   358    postureCheckDomainPatch:
   359      allOf:
   360        - $ref: '#/definitions/postureCheckPatch'
   361        - type: object
   362          properties:
   363            domains:
   364              type: array
   365              minItems: 1
   366              items:
   367                type: string
   368      x-class: "DOMAIN"
   369  
   370    ###################################################################
   371    # Posture Check MAC Address
   372    ###################################################################
   373    postureCheckMacAddressDetail:
   374      allOf:
   375        - $ref: '#/definitions/postureCheckDetail'
   376        - type: object
   377          required:
   378            - macAddresses
   379          properties:
   380            macAddresses:
   381              type: array
   382              minItems: 1
   383              items:
   384                type: string
   385  
   386      x-class: "MAC"
   387  
   388    postureCheckMacAddressCreate:
   389      allOf:
   390        - $ref: '#/definitions/postureCheckCreate'
   391        - type: object
   392          required:
   393            - macAddresses
   394          properties:
   395            macAddresses:
   396              type: array
   397              minItems: 1
   398              items:
   399                type: string
   400      x-class: "MAC"
   401  
   402    postureCheckMacAddressUpdate:
   403      allOf:
   404        - $ref: '#/definitions/postureCheckUpdate'
   405        - type: object
   406          required:
   407            - macAddresses
   408          properties:
   409            macAddresses:
   410              type: array
   411              minItems: 1
   412              items:
   413                type: string
   414      x-class: "MAC"
   415  
   416    postureCheckMacAddressPatch:
   417      allOf:
   418        - $ref: '#/definitions/postureCheckPatch'
   419        - type: object
   420          properties:
   421            macAddresses:
   422              type: array
   423              minItems: 1
   424              items:
   425                type: string
   426      x-class: "MAC"
   427  
   428    ###################################################################
   429    # Posture Check Process
   430    ###################################################################
   431    process:
   432      type: object
   433      required:
   434        - osType
   435        - path
   436      properties:
   437        osType:
   438          $ref: '../shared/posture-checks.yml#/definitions/osType'
   439        path:
   440          type: string
   441        hashes:
   442          type: array
   443          items:
   444            type: string
   445        signerFingerprint:
   446          type: string
   447  
   448    postureCheckProcessDetail:
   449      allOf:
   450        - $ref: '#/definitions/postureCheckDetail'
   451        - type: object
   452          required:
   453            - process
   454          properties:
   455            process:
   456              $ref: '#/definitions/process'
   457      x-class: "PROCESS"
   458  
   459    postureCheckProcessCreate:
   460      allOf:
   461        - $ref: '#/definitions/postureCheckCreate'
   462        - type: object
   463          required:
   464            - process
   465          properties:
   466            process:
   467              $ref: '#/definitions/process'
   468      x-class: "PROCESS"
   469  
   470    postureCheckProcessUpdate:
   471      allOf:
   472        - $ref: '#/definitions/postureCheckUpdate'
   473        - type: object
   474          required:
   475            - process
   476          properties:
   477            process:
   478              $ref: '#/definitions/process'
   479      x-class: "PROCESS"
   480  
   481    postureCheckProcessPatch:
   482      allOf:
   483        - $ref: '#/definitions/postureCheckPatch'
   484        - type: object
   485          properties:
   486            process:
   487              $ref: '#/definitions/process'
   488      x-class: "PROCESS"
   489  
   490    ###################################################################
   491    # Posture Check Process Multi
   492    ###################################################################
   493    processMulti:
   494      type: object
   495      required:
   496        - osType
   497        - path
   498      properties:
   499        osType:
   500          $ref: '../shared/posture-checks.yml#/definitions/osType'
   501        path:
   502          type: string
   503        hashes:
   504          type: array
   505          items:
   506            type: string
   507        signerFingerprints:
   508          type: array
   509          items:
   510            type: string
   511  
   512    postureCheckProcessMultiDetail:
   513      allOf:
   514        - $ref: '#/definitions/postureCheckDetail'
   515        - type: object
   516          required:
   517            - semantic
   518            - processes
   519          properties:
   520            semantic:
   521              $ref: '../shared/base-entity.yml#/definitions/semantic'
   522            processes:
   523              type: array
   524              minItems: 1
   525              items:
   526                $ref: '#/definitions/processMulti'
   527      x-class: "PROCESS_MULTI"
   528  
   529    postureCheckProcessMultiCreate:
   530      allOf:
   531        - $ref: '#/definitions/postureCheckCreate'
   532        - type: object
   533          required:
   534            - semantic
   535            - processes
   536          properties:
   537            semantic:
   538              $ref: '../shared/base-entity.yml#/definitions/semantic'
   539            processes:
   540              type: array
   541              minItems: 1
   542              items:
   543                $ref: '#/definitions/processMulti'
   544      x-class: "PROCESS_MULTI"
   545  
   546    postureCheckProcessMultiUpdate:
   547      allOf:
   548        - $ref: '#/definitions/postureCheckUpdate'
   549        - type: object
   550          required:
   551            - semantic
   552            - processes
   553          properties:
   554            semantic:
   555              $ref: '../shared/base-entity.yml#/definitions/semantic'
   556            processes:
   557              type: array
   558              minItems: 1
   559              items:
   560                $ref: '#/definitions/processMulti'
   561      x-class: "PROCESS_MULTI"
   562  
   563    postureCheckProcessMultiPatch:
   564      allOf:
   565        - $ref: '#/definitions/postureCheckPatch'
   566        - type: object
   567          properties:
   568            semantic:
   569              $ref: '../shared/base-entity.yml#/definitions/semantic'
   570            processes:
   571              type: array
   572              minItems: 1
   573              items:
   574                $ref: '#/definitions/processMulti'
   575      x-class: "PROCESS_MULTI"
   576  
   577    ###################################################################
   578    # Posture Check MFA
   579    ###################################################################
   580    postureCheckMfaProperties:
   581      type: object
   582      properties:
   583        timeoutSeconds:
   584          type: integer
   585        promptOnWake:
   586          type: boolean
   587        promptOnUnlock:
   588          type: boolean
   589        ignoreLegacyEndpoints:
   590          type: boolean
   591  
   592    postureCheckMfaPropertiesPatch:
   593      type: object
   594      properties:
   595        timeoutSeconds:
   596          type: integer
   597          x-nullable: true
   598        promptOnWake:
   599          type: boolean
   600          x-nullable: true
   601        promptOnUnlock:
   602          type: boolean
   603          x-nullable: true
   604        ignoreLegacyEndpoints:
   605          type: boolean
   606          x-nullable: true
   607  
   608    postureCheckMfaDetail:
   609      allOf:
   610        - $ref: '#/definitions/postureCheckDetail'
   611        - $ref: '#/definitions/postureCheckMfaProperties'
   612      x-class: "MFA"
   613  
   614    postureCheckMfaCreate:
   615      allOf:
   616        - $ref: '#/definitions/postureCheckCreate'
   617        - $ref: '#/definitions/postureCheckMfaProperties'
   618      x-class: "MFA"
   619  
   620  
   621    postureCheckMfaUpdate:
   622      allOf:
   623        - $ref: '#/definitions/postureCheckUpdate'
   624        - $ref: '#/definitions/postureCheckMfaProperties'
   625      x-class: "MFA"
   626  
   627    postureCheckMfaPatch:
   628      allOf:
   629        - $ref: '#/definitions/postureCheckPatch'
   630        - $ref: '#/definitions/postureCheckMfaPropertiesPatch'
   631      x-class: "MFA"