postman/json-schema/postman-workspace-schema.json at main · api-evangelist/postman · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://postman.com/schemas/postman/workspace.json",
  "title": "Postman Workspace",
  "description": "A Postman workspace that provides an isolated environment for organizing API development work. Workspaces contain collections, environments, mock servers, monitors, and APIs, and support collaboration through shared team access.",
  "type": "object",
  "required": ["id", "name", "type"],
  "properties": {
    "id": {
      "type": "string",
      "description": "The workspace's unique identifier."
    },
    "name": {
      "type": "string",
      "description": "The workspace name."
    },
    "type": {
      "type": "string",
      "enum": ["personal", "team", "private", "public", "partner"],
      "description": "The workspace type. Personal workspaces are visible only to the owner. Team workspaces are shared with all team members. Private workspaces have restricted access. Public workspaces are visible to everyone. Partner workspaces enable collaboration with external partners."
    },
    "description": {
      "type": "string",
      "description": "The workspace description."
    },
    "visibility": {
      "type": "string",
      "enum": ["personal", "team", "private", "public", "partner"],
      "description": "The workspace visibility setting."
    },
    "createdBy": {
      "type": "string",
      "description": "The user ID of the workspace creator."
    },
    "updatedBy": {
      "type": "string",
      "description": "The user ID of the last person to update the workspace."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the workspace was created."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the workspace was last updated."
    },
    "collections": {
      "type": "array",
      "description": "Collections in this workspace.",
      "items": {
        "$ref": "#/$defs/WorkspaceResource"
      }
    },
    "environments": {
      "type": "array",
      "description": "Environments in this workspace.",
      "items": {
        "$ref": "#/$defs/WorkspaceResource"
      }
    },
    "mocks": {
      "type": "array",
      "description": "Mock servers in this workspace.",
      "items": {
        "$ref": "#/$defs/WorkspaceResource"
      }
    },
    "monitors": {
      "type": "array",
      "description": "Monitors in this workspace.",
      "items": {
        "$ref": "#/$defs/WorkspaceResource"
      }
    },
    "apis": {
      "type": "array",
      "description": "APIs in this workspace.",
      "items": {
        "$ref": "#/$defs/WorkspaceResource"
      }
    }
  },
  "$defs": {
    "WorkspaceResource": {
      "type": "object",
      "description": "A resource linked to the workspace.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The resource's unique ID."
        },
        "name": {
          "type": "string",
          "description": "The resource name."
        },
        "uid": {
          "type": "string",
          "description": "The resource's UID."
        }
      }
    }
  }
}