codesandboxsdk-go/openapi.port.yaml at main · CallstackAI/codesandboxsdk-go · 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
openapi: 3.0.0
info:
  title: Port API
  description: API for managing sandbox port operations
  version: 1.0.0
paths:
  /port/list:
    post:
      summary: List ports
      description: Retrieve a list of available ports and their URLs
      operationId: portList
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessResponse'
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          list:
                            type: array
                            items:
                              $ref: '#/components/schemas/Port'
                            description: List of available ports
                        required:
                          - list
        '400':
          description: Error listing ports
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - type: object
                    properties:
                      error:
                        $ref: '#/components/schemas/CommonError'
components:
  schemas:
    SuccessResponse:
      type: object
      properties:
        status:
          type: number
          enum:
            - 0
          description: Status code for successful operations
        result:
          type: object
          description: Result payload for the operation
      required:
        - status
        - result
    ErrorResponse:
      type: object
      properties:
        status:
          type: number
          enum:
            - 1
          description: Status code for error operations
        error:
          type: object
          description: Error details
      required:
        - status
        - error
    CommonError:
      type: object
      properties:
        code:
          type: number
          description: Error code
        message:
          type: string
          description: Error message
        data:
          type: object
          description: Additional error data
          nullable: true
      required:
        - code
        - message
    Port:
      type: object
      properties:
        port:
          type: number
          description: Port number
        url:
          type: string
          description: URL to access the service on this port
      required:
        - port
        - url