get.json 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. {
  2. "operationId": "getUser",
  3. "summary": "Get a user",
  4. "tags": ["Users"],
  5. "security": [
  6. {
  7. "BearerAuth": ["users"]
  8. }
  9. ],
  10. "parameters": [
  11. {
  12. "in": "path",
  13. "name": "userID",
  14. "schema": {
  15. "oneOf": [
  16. {
  17. "type": "string",
  18. "pattern": "^me$"
  19. },
  20. {
  21. "type": "integer",
  22. "minimum": 1
  23. }
  24. ]
  25. },
  26. "required": true,
  27. "description": "User ID or 'me' for yourself",
  28. "example": 1
  29. }
  30. ],
  31. "responses": {
  32. "200": {
  33. "description": "200 response",
  34. "content": {
  35. "application/json": {
  36. "examples": {
  37. "default": {
  38. "value": {
  39. "id": 1,
  40. "created_on": "2020-01-30T09:36:08.000Z",
  41. "modified_on": "2020-01-30T09:41:04.000Z",
  42. "is_disabled": false,
  43. "email": "[email protected]",
  44. "name": "Jamie Curnow",
  45. "nickname": "James",
  46. "avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
  47. "roles": ["admin"]
  48. }
  49. }
  50. },
  51. "schema": {
  52. "$ref": "../../../components/user-object.json"
  53. }
  54. }
  55. }
  56. }
  57. }
  58. }