Files
ziti/specs/source/client/posture-response.yml
T
Andrew Martinez b562fb5c07 splits API specs into composible modules
- splits Open API 2.0 (swagger) into client/management APIs
- uses go-swaggers flatten capabilities
- uses newer version of go-swagger (v0.27.0)
- introduces /edge/client/v1, /edge/management/v1
- non-prefixed URLs default to /edge/client/v1
- splits some shared management/client API handlers
- renames some REST models to "client" instead of "limited"
- passes all apitests, fails dataflow upd test (main fails this as well)
- updates generate rest script for powershell
- todo: test generate rest script for bash
- todo: use xweb (different branch)
2021-05-04 11:30:32 -04:00

124 lines
3.2 KiB
YAML

---
paths:
posture-response:
post:
summary: Submit a posture response to a posture query
description: Submits posture responses
security:
- ztSession: [ ]
tags:
- Posture Checks
operationId: createPostureResponse
parameters:
- name: postureResponse
in: body
required: true
description: A Posture Response
schema:
$ref: '#/definitions/postureResponseCreate'
responses:
'201':
$ref: '../shared/standard-responses.yml#/responses/createResponse'
'400':
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
'401':
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
posture-response-bulk:
post:
summary: Submit multiple posture responses
description: Submits posture responses
security:
- ztSession: [ ]
tags:
- Posture Checks
operationId: createPostureResponseBulk
parameters:
- name: postureResponse
in: body
required: true
description: A Posture Response
schema:
# using a named array definition causes issues w/ code gen
type: array
items:
$ref: "#/definitions/postureResponseCreate"
responses:
'200':
$ref: '../shared/standard-responses.yml#/responses/emptyResponse'
'400':
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
'401':
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
responses:
definitions:
postureResponseCreate:
type: object
discriminator: typeId
required:
- id
- typeId
properties:
id:
type: string
typeId:
$ref: '../shared/posture-checks.yml#/definitions/postureCheckType'
postureResponseOperatingSystemCreate:
allOf:
- $ref: '#/definitions/postureResponseCreate'
- type: object
required:
- type
- version
properties:
type:
type: string
version:
type: string
build:
type: string
x-class: "OS"
postureResponseDomainCreate:
allOf:
- $ref: '#/definitions/postureResponseCreate'
- type: object
required:
- domain
properties:
domain:
type: string
x-class: "DOMAIN"
postureResponseMacAddressCreate:
allOf:
- $ref: '#/definitions/postureResponseCreate'
- type: object
required:
- macAddresses
properties:
macAddresses:
type: array
items:
type: string
x-class: "MAC"
postureResponseProcessCreate:
allOf:
- $ref: '#/definitions/postureResponseCreate'
- type: object
required:
- process
properties:
path:
type: string
isRunning:
type: boolean
hash:
type: string
signerFingerprints:
type: array
items:
type: string
x-class: "PROCESS"