medusa/www/apps/api-reference/specs/admin/paths/admin_layouts_{zone}_configuration.yaml at aec2ab135d7c84cb681acf5faafbc44ffb3330bc · medusajs/medusa · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
get:
  operationId: GetLayoutsZoneConfiguration
  summary: List Layout Configurations
  description: >-
    Retrieve a list of layout configurations for a specific zone. These are the
    configurations made by the users for their admin dashboard layouts.
  x-authenticated: true
  parameters:
    - name: zone
      in: path
      description: The zone for which the layout configurations should be retrieved.
      required: true
      schema:
        type: string
  security:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
  x-codeSamples:
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_layouts_{zone}_configuration/get.sh
  tags:
    - Layouts
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminLayoutConfigurationResponse.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
  x-since: 2.17.2
post:
  operationId: PostLayoutsZoneConfiguration
  summary: Add Layout Configuration
  description: >-
    Add a layout configuration for a specific zone. This allows you to customize
    the layout of the admin dashboard for that zone, including the arrangement
    of widgets and other UI elements.
  x-authenticated: true
  parameters:
    - name: zone
      in: path
      description: The zone for which the layout configuration should be added.
      required: true
      schema:
        type: string
  security:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
  requestBody:
    content:
      application/json:
        schema:
          $ref: ../components/schemas/AdminSetLayoutConfiguration.yaml
  x-codeSamples:
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_layouts_{zone}_configuration/post.sh
  tags:
    - Layouts
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminLayoutConfigurationResponse.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: setLayoutConfigurationWorkflow
  x-events: []
  x-since: 2.17.2
delete:
  operationId: DeleteLayoutsZoneConfiguration
  summary: Clear Configuration of Layout
  description: >-
    Clears all user layout configurations for a given zone. This action will
    remove any customizations made by the user and revert to the system
    defaults.
  x-authenticated: true
  parameters:
    - name: zone
      in: path
      description: The zone for which the layout configuration should be cleared.
      required: true
      schema:
        type: string
  security:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
  x-codeSamples:
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_layouts_{zone}_configuration/delete.sh
  tags:
    - Layouts
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            description: The details of the layout configuration deletion result.
            required:
              - success
            properties:
              success:
                type: boolean
                title: success
                description: Whether the layout configuration was successfully cleared.
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
  x-workflow: clearLayoutConfigurationWorkflow
  x-events: []
  x-since: 2.17.2