wrap/container/http-api/0.1.yaml at 5642bc4c87917cd3f5feb1605d40cef1c8ef53a3 · polywrap/wrap · 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
openapi: 3.0.0
info:
  description: Wrap Container APIs
  version: "0.0.1"
  title: Wrap Containers HTTP API
paths:
  /invoke:
    post:
      summary: Invoke a wrapper
      description: Invoke a wrapper given a uri, method and args
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvokeOptions'
      responses:
        '200':
          description: invocation execution successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvokeResult'
        '400':
          description: bad input parameter
  /validate:
    post:
      summary: Validate a wrapper
      description: Validate if a wrapper is compatible with client
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateOptions'
      responses:
        '200':
          description: validation check successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateResult'
        '400':
          description: bad input parameter
  /versions/{v}:
    get:
      summary: Get version of client or wrap
      parameters:
        - name: "v"
          in: "path"
          description: "v=client or v=wrap"
          required: true
          schema:
            type: "string"
      responses:
        '200':
          description: 'version of client or wrap'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'


components:
  schemas:
    InvokeOptions:
      type: object
      required:
        - method
        - uri
      properties:
        method:
          type: string
          example: method_name
        uri:
          type: string
          example: ens/wrapper.eth
        args:
          type: object
    InvokeResult:
      type: object
      properties:
        data:
          type: object
        error:
          type: object
    ValidateOptions:
      type: object
      properties:
        abi:
          type: boolean
          description: make sure the ABI from 1st level dependencies are available
        recursive:
          type: boolean
          description: check all uris and make sure it can resolve them
    ValidateResult:
      type: object
      properties:
        valid:
          type: boolean
    Version:
      type: object
      properties:
        client:
          type: string
        wrap:
          type: string