tag-details.json 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. {
  2. "get": {
  3. "tags": ["Events"],
  4. "description": "Returns details for given tag key related to an issue.",
  5. "operationId": "Retrieve Tag Details",
  6. "parameters": [
  7. {
  8. "name": "organization_id_or_slug",
  9. "in": "path",
  10. "description": "The id or slug of the organization the issue belongs to.",
  11. "required": true,
  12. "schema": {
  13. "type": "string"
  14. }
  15. },
  16. {
  17. "name": "issue_id",
  18. "in": "path",
  19. "description": "The ID of the issue to retrieve.",
  20. "required": true,
  21. "schema": {
  22. "type": "string"
  23. }
  24. },
  25. {
  26. "name": "key",
  27. "in": "path",
  28. "description": "The tag key to look the values up for.",
  29. "required": true,
  30. "schema": {
  31. "type": "string"
  32. }
  33. }
  34. ],
  35. "responses": {
  36. "200": {
  37. "description": "Success",
  38. "content": {
  39. "application/json": {
  40. "schema": {
  41. "type": "object",
  42. "required": ["key", "totalValues"],
  43. "properties": {
  44. "key": {
  45. "type": "string"
  46. },
  47. "totalValues": {
  48. "type": "integer"
  49. }
  50. }
  51. },
  52. "example": {
  53. "key": "ice_cream",
  54. "totalValues": 6
  55. }
  56. }
  57. }
  58. },
  59. "403": {
  60. "description": "Forbidden"
  61. }
  62. },
  63. "security": [
  64. {
  65. "auth_token": ["event:read"]
  66. }
  67. ]
  68. }
  69. }