Advertisement
Guest User

test123Swagger

a guest
Jun 21st, 2017
198
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 9.03 KB | None | 0 0
  1. swagger: '2.0'
  2. info:
  3. title: VIPCard Crypto - US01
  4. version: 1.0.0
  5. description: 'Dedicated, isolated, cryptographic processing'
  6. termsOfService: 'http://getvalid.com/terms/'
  7. contact:
  8. name: API Support
  9. url: 'http://www.getvalid.com/support'
  10. email: support@getvalid.com
  11. license:
  12. name: Apache 2.0
  13. url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
  14. host: validcryptous01functions.azurewebsites.net
  15. basePath: /
  16. schemes:
  17. - https
  18. paths:
  19. '/api/Enroll/{PublisherID}/{SpecificationID}':
  20. post:
  21. tags:
  22. - Publisher
  23. operationId: '/api/Enroll/{PublisherID}/{SpecificationID}/post'
  24. produces:
  25. - application/json
  26. consumes:
  27. - application/json
  28. parameters:
  29. - name: PublisherID
  30. in: path
  31. required: true
  32. type: string
  33. - name: SpecificationID
  34. in: path
  35. required: true
  36. type: string
  37. description: Sign a VIPCard's public key
  38. responses:
  39. '200':
  40. description: Success operation
  41. headers:
  42. X-Rate-Limit-Limit:
  43. description: The number of allowed requests in the current period
  44. type: integer
  45. X-Rate-Limit-Remaining:
  46. description: The number of remaining requests in the current period
  47. type: integer
  48. X-Rate-Limit-Reset:
  49. description: The number of seconds left in the current period
  50. type: integer
  51. security:
  52. - apikeyQuery: []
  53. '/api/Renew/{PublisherID}/{SpecificationID}':
  54. post:
  55. tags:
  56. - Publisher
  57. operationId: '/api/Renew/{PublisherID}/{SpecificationID}/post'
  58. produces:
  59. - application/json
  60. consumes:
  61. - application/json
  62. parameters:
  63. - name: PublisherID
  64. in: path
  65. required: true
  66. type: string
  67. - name: SpecificationID
  68. in: path
  69. required: true
  70. type: string
  71. description: >-
  72. Special function allowing the isolated renewal of data, without exposing
  73. attributes to the publisher
  74. responses:
  75. '200':
  76. description: Success operation
  77. headers:
  78. X-Rate-Limit-Limit:
  79. description: The number of allowed requests in the current period
  80. type: integer
  81. X-Rate-Limit-Remaining:
  82. description: The number of remaining requests in the current period
  83. type: integer
  84. X-Rate-Limit-Reset:
  85. description: The number of seconds left in the current period
  86. type: integer
  87. security:
  88. - apikeyQuery: []
  89. '/api/TokenPolicy/{PublisherID}':
  90. get:
  91. tags:
  92. - Publisher
  93. operationId: '/api/TokenPolicy/{PublisherID}//get'
  94. produces:
  95. - application/json
  96. consumes:
  97. - application/json
  98. parameters:
  99. - name: PublisherID
  100. in: path
  101. required: true
  102. type: string
  103. description: >-
  104. Create a Publisher and a Specification so that it can later create
  105. VIPCards
  106. responses:
  107. '200':
  108. description: Success operation
  109. headers:
  110. X-Rate-Limit-Limit:
  111. description: The number of allowed requests in the current period
  112. type: integer
  113. X-Rate-Limit-Remaining:
  114. description: The number of remaining requests in the current period
  115. type: integer
  116. X-Rate-Limit-Reset:
  117. description: The number of seconds left in the current period
  118. type: integer
  119. '/api/TokenPolicy/{PublisherID}/{SpecificationID}':
  120. get:
  121. tags:
  122. - Publisher
  123. operationId: '/api/TokenPolicy/{PublisherID}/{SpecificationID}/get'
  124. produces:
  125. - application/json
  126. consumes:
  127. - application/json
  128. parameters:
  129. - name: PublisherID
  130. in: path
  131. required: true
  132. type: string
  133. - name: SpecificationID
  134. in: path
  135. required: true
  136. type: string
  137. description: >-
  138. Create an Publisher and a Specification so that it can later create
  139. VIPCards
  140. responses:
  141. '200':
  142. description: Success operation
  143. headers:
  144. X-Rate-Limit-Limit:
  145. description: The number of allowed requests in the current period
  146. type: integer
  147. X-Rate-Limit-Remaining:
  148. description: The number of remaining requests in the current period
  149. type: integer
  150. X-Rate-Limit-Reset:
  151. description: The number of seconds left in the current period
  152. type: integer
  153. post:
  154. tags:
  155. - Publisher
  156. operationId: '/api/TokenPolicy/{PublisherID}/{SpecificationID}/post'
  157. produces:
  158. - application/json
  159. consumes:
  160. - application/json
  161. parameters:
  162. - name: PublisherID
  163. in: path
  164. required: true
  165. type: string
  166. - name: SpecificationID
  167. in: path
  168. required: true
  169. type: string
  170. - name: CreationData
  171. description: user to add to the system
  172. required: true
  173. in: body
  174. schema:
  175. $ref: '#/definitions/PublisherSpecification'
  176. responses:
  177. '200':
  178. description: Success operation
  179. headers:
  180. X-Rate-Limit-Limit:
  181. description: The number of allowed requests in the current period
  182. type: integer
  183. X-Rate-Limit-Remaining:
  184. description: The number of remaining requests in the current period
  185. type: integer
  186. X-Rate-Limit-Reset:
  187. description: The number of seconds left in the current period
  188. type: integer
  189. security:
  190. - apikeyQuery: []
  191. '/api/Verify/{TokenID}':
  192. post:
  193. tags:
  194. - Scanner
  195. operationId: '/api/Verify/{TokenID}/post'
  196. produces:
  197. - application/json
  198. consumes:
  199. - application/json
  200. parameters:
  201. - name: TokenID
  202. in: path
  203. required: true
  204. type: string
  205. description: >-
  206. Replace with Operation Object
  207. #http://swagger.io/specification/#operationObject
  208. responses:
  209. '200':
  210. description: Success operation
  211. headers:
  212. X-Rate-Limit-Limit:
  213. description: The number of allowed requests in the current period
  214. type: integer
  215. X-Rate-Limit-Remaining:
  216. description: The number of remaining requests in the current period
  217. type: integer
  218. X-Rate-Limit-Reset:
  219. description: The number of seconds left in the current period
  220. type: integer
  221. security:
  222. - apikeyQuery: []
  223. definitions:
  224. PublisherSpecification:
  225. description: Base information representing the publisher data
  226. allOf:
  227. - type: object
  228. properties:
  229. UIDP:
  230. type: string
  231. description: >-
  232. A base64 byte[] typically the lowercase DNS TLD name of the
  233. publisher
  234. example: domain.com
  235. Specification:
  236. type: string
  237. description: 'A base64 byte[] representing the data policy'
  238. example: {}
  239. NumberOfAttributes:
  240. type: integer
  241. maximum: 50
  242. minimum: 0
  243. default: 0
  244. description: >-
  245. A base64 byte[] representing the number of attributes defined in
  246. the Spec
  247. NonHashedValues:
  248. type: string
  249. description: >-
  250. A zero based array definfining which attributes are to be hashed.
  251. Homomorphic encryption requires non hashed values
  252. DeviceSupport:
  253. type: boolean
  254. default: false
  255. description: Is hardware support required?
  256. HashType:
  257. type: string
  258. description: The hash type used to encrypt attributes
  259. default: SHA256
  260. enum:
  261. - SHA1
  262. - SHA256
  263. - SHA384
  264. - SHA512
  265. ParameterSet:
  266. type: string
  267. description: >-
  268. The algorithm used to protect the data. EC is much smaller and
  269. faster than subgroups
  270. default: EC_P256_V1
  271. enum:
  272. - SubGroup_2048_256V1
  273. - SubGroup_3072_256V1
  274. - SubGroup_1024_160V1
  275. - EC_BN254_V1
  276. - EC_P256_V1
  277. - EC_P384_V1
  278. - EC_P521_V1
  279. required:
  280. - UIDP
  281. - ParameterSet
  282. - Specification
  283. - NumberOfAttributes
  284. - NonHashedValues
  285. - HashType
  286. securityDefinitions:
  287. apikeyQuery:
  288. type: apiKey
  289. name: code
  290. in: query
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement