{"swagger":"2.0","info":{"description":"vtotbtokenms API documentation","version":"0.0.1","title":"vtotbtokenms API","contact":{},"license":{"name":"unlicensed"}},"host":"vto-tbts.dev.luxdeepblue.com","basePath":"/","tags":[{"name":"channel-resource","description":"Channel Resource"},{"name":"payload-config-resource","description":"Payload Config Resource"},{"name":"payload-schema-resource","description":"Payload Schema Resource"},{"name":"schema-resource-v-1","description":"Schema Resource V 1"},{"name":"token-resource-v-1","description":"Token Resource V 1"}],"paths":{"/api/channels":{"get":{"tags":["channel-resource"],"summary":"getAllChannels","operationId":"getAllChannelsUsingGET","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Page number of the requested page","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Size of a page","required":false,"type":"integer","format":"int32"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ChannelDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["channel-resource"],"summary":"createChannel","operationId":"createChannelUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"channelDTO","description":"channelDTO","required":true,"schema":{"$ref":"#/definitions/ChannelDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ChannelDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["channel-resource"],"summary":"updateChannel","operationId":"updateChannelUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"channelDTO","description":"channelDTO","required":true,"schema":{"$ref":"#/definitions/ChannelDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ChannelDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/channels/{id}":{"get":{"tags":["channel-resource"],"summary":"getChannel","operationId":"getChannelUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ChannelDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["channel-resource"],"summary":"deleteChannel","operationId":"deleteChannelUsingDELETE","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/api/payload-configs":{"get":{"tags":["payload-config-resource"],"summary":"getAllPayloadConfigs","operationId":"getAllPayloadConfigsUsingGET","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Page number of the requested page","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Size of a page","required":false,"type":"integer","format":"int32"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PayloadConfigDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["payload-config-resource"],"summary":"createPayloadConfig","operationId":"createPayloadConfigUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"payloadConfigDTO","description":"payloadConfigDTO","required":true,"schema":{"$ref":"#/definitions/PayloadConfigDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PayloadConfigDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["payload-config-resource"],"summary":"updatePayloadConfig","operationId":"updatePayloadConfigUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"payloadConfigDTO","description":"payloadConfigDTO","required":true,"schema":{"$ref":"#/definitions/PayloadConfigDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PayloadConfigDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/payload-configs/{id}":{"get":{"tags":["payload-config-resource"],"summary":"getPayloadConfig","operationId":"getPayloadConfigUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PayloadConfigDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["payload-config-resource"],"summary":"deletePayloadConfig","operationId":"deletePayloadConfigUsingDELETE","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/api/payload-schemas":{"get":{"tags":["payload-schema-resource"],"summary":"getAllPayloadSchemas","operationId":"getAllPayloadSchemasUsingGET","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Page number of the requested page","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Size of a page","required":false,"type":"integer","format":"int32"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PayloadSchemaDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["payload-schema-resource"],"summary":"createPayloadSchema","operationId":"createPayloadSchemaUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"payloadSchemaDTO","description":"payloadSchemaDTO","required":true,"schema":{"$ref":"#/definitions/PayloadSchemaDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PayloadSchemaDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["payload-schema-resource"],"summary":"updatePayloadSchema","operationId":"updatePayloadSchemaUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"payloadSchemaDTO","description":"payloadSchemaDTO","required":true,"schema":{"$ref":"#/definitions/PayloadSchemaDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PayloadSchemaDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/payload-schemas/{id}":{"get":{"tags":["payload-schema-resource"],"summary":"getPayloadSchema","operationId":"getPayloadSchemaUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PayloadSchemaDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["payload-schema-resource"],"summary":"deletePayloadSchema","operationId":"deletePayloadSchemaUsingDELETE","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/public/v1/schema/{channel}":{"get":{"tags":["schema-resource-v-1"],"summary":"getByChannel","operationId":"getByChannelUsingGET","produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"name":"schemaName","in":"query","description":"schemaName","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JsonNode"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["schema-resource-v-1"],"summary":"updateByChannel","operationId":"updateByChannelUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"in":"body","name":"schema","description":"schema","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"schemaName","in":"query","description":"schemaName","required":false,"type":"string"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/public/v1/token/{channel}":{"post":{"tags":["token-resource-v-1"],"summary":"createByChannel","operationId":"createByChannelUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/public/v1/token/{channel}/{token}":{"get":{"tags":["token-resource-v-1"],"summary":"readPayload","operationId":"readPayloadUsingGET","produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["token-resource-v-1"],"summary":"writePayload","operationId":"writePayloadUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"in":"body","name":"payload","description":"payload","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["token-resource-v-1"],"summary":"deleteTokenPayload","operationId":"deleteTokenPayloadUsingDELETE","produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/public/v1/token/{channel}/{token}/active":{"get":{"tags":["token-resource-v-1"],"summary":"isActive","operationId":"isActiveUsingGET","produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/public/v1/token/{channel}/{token}/status":{"get":{"tags":["token-resource-v-1"],"summary":"getStatus","operationId":"getStatusUsingGET","produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string","enum":["TOKEN_VALID_PAYLOAD_UNAVAILABLE","TOKEN_VALID_PAYLOAD_AVAILABLE","TOKEN_NOT_VALID"]}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/public/v1/token/{channel}/{token}/ttl-extend":{"put":{"tags":["token-resource-v-1"],"summary":"updateTokenPayloadTTL","operationId":"updateTokenPayloadTTLUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"channel","in":"path","description":"channel","required":true,"type":"string"},{"name":"token","in":"path","description":"token","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}}},"definitions":{"ChannelDTO":{"type":"object","required":["channel","tokenFormat"],"properties":{"channel":{"type":"string"},"id":{"type":"integer","format":"int64"},"tokenFormat":{"type":"string","enum":["N_DIGIT","UUID"]},"ttl":{"$ref":"#/definitions/Duration"}},"title":"ChannelDTO"},"Duration":{"type":"object","properties":{"nano":{"type":"integer","format":"int32"},"negative":{"type":"boolean"},"seconds":{"type":"integer","format":"int64"},"units":{"type":"array","items":{"$ref":"#/definitions/TemporalUnit"}},"zero":{"type":"boolean"}},"title":"Duration"},"JsonNode":{"type":"object","properties":{"array":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"binary":{"type":"boolean"},"boolean":{"type":"boolean"},"containerNode":{"type":"boolean"},"double":{"type":"boolean"},"empty":{"type":"boolean"},"float":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"int":{"type":"boolean"},"integralNumber":{"type":"boolean"},"long":{"type":"boolean"},"missingNode":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"null":{"type":"boolean"},"number":{"type":"boolean"},"object":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"textual":{"type":"boolean"},"valueNode":{"type":"boolean"}},"title":"JsonNode"},"PayloadConfigDTO":{"type":"object","properties":{"channelChannel":{"type":"string"},"channelId":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"},"isWriteOnce":{"type":"boolean"},"schemaId":{"type":"integer","format":"int64"},"schemaName":{"type":"string"},"ttl":{"$ref":"#/definitions/Duration"},"ttlIncrement":{"$ref":"#/definitions/Duration"}},"title":"PayloadConfigDTO"},"PayloadSchemaDTO":{"type":"object","required":["name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"schema":{"type":"string"}},"title":"PayloadSchemaDTO"},"TemporalUnit":{"type":"object","properties":{"dateBased":{"type":"boolean"},"duration":{"$ref":"#/definitions/Duration"},"durationEstimated":{"type":"boolean"},"timeBased":{"type":"boolean"}},"title":"TemporalUnit"}}}