Skip to content

Commit 9d9fdd1

Browse files
aNNiMONaNNiMON
committed
[okhttp] Add docs
1 parent bfb21ec commit 9d9fdd1

File tree

3 files changed

+217
-5
lines changed

3 files changed

+217
-5
lines changed

‎docs/src/docgen-md.own

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ MODULES = [
1313
"files",
1414
"functional",
1515
"http",
16+
"okhttp",
1617
"java",
1718
"math",
1819
"ounit",

‎docs/src/modules/okhttp.yml

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
name: okhttp
2+
since: 2.0.0
3+
scope: both
4+
constants:
5+
- name: MultipartBody
6+
type: 4
7+
typeName: map
8+
value: MultipartBodyValue
9+
- name: RequestBody
10+
type: 4
11+
typeName: map
12+
value: RequestBodyValue
13+
- name: okhttp
14+
type: 4
15+
typeName: map
16+
value: OkHttpValue
17+
functions: []
18+
types:
19+
- name: CallValue
20+
functions:
21+
- name: cancel
22+
args: ''
23+
desc: ''
24+
desc_ru: ''
25+
- name: enqueue
26+
args: 'onResponse, onFailure=def(call, errorMessage)'
27+
desc: ''
28+
desc_ru: ''
29+
- name: execute
30+
args: ''
31+
desc: ''
32+
desc_ru: ''
33+
- name: isCanceled
34+
args: ''
35+
desc: ''
36+
desc_ru: ''
37+
- name: isExecuted
38+
args: ''
39+
desc: ''
40+
desc_ru: ''
41+
- name: MultipartBodyValue
42+
constants:
43+
- name: ALTERNATIVE
44+
type: 2
45+
typeName: string
46+
value: multipart/alternative
47+
- name: DIGEST
48+
type: 2
49+
typeName: string
50+
value: multipart/digest
51+
- name: FORM
52+
type: 2
53+
typeName: string
54+
value: multipart/form-data
55+
- name: MIXED
56+
type: 2
57+
typeName: string
58+
value: multipart/mixed
59+
- name: PARALLEL
60+
type: 2
61+
typeName: string
62+
value: multipart/parallel
63+
functions:
64+
- name: builder
65+
args: ''
66+
desc: returns MultipartBodyBuilderValue
67+
desc_ru: dозвращает MultipartBodyBuilderValue
68+
- name: MultipartBodyBuilderValue
69+
functions:
70+
- name: addFormData
71+
args: 'data'
72+
desc: ''
73+
desc_ru: ''
74+
- name: addFormDataPart
75+
args: 'name, value, requestBody = empty'
76+
desc: ''
77+
desc_ru: ''
78+
- name: addPart
79+
args: 'requestBody, headers = {}'
80+
desc: ''
81+
desc_ru: ''
82+
- name: build
83+
args: ''
84+
desc: creates and returns MultipartBodyValue
85+
desc_ru: создаёт и возвращает MultipartBodyValue
86+
- name: setType
87+
args: 'type'
88+
desc: ''
89+
desc_ru: ''
90+
- name: RequestBuilderValue
91+
functions:
92+
- name: addHeader
93+
args: 'name, value'
94+
desc: ''
95+
desc_ru: ''
96+
- name: cacheControl
97+
args: ''
98+
desc: ''
99+
desc_ru: ''
100+
- name: delete
101+
args: 'requestBody = empty'
102+
desc: ''
103+
desc_ru: ''
104+
- name: get
105+
args: ''
106+
desc: ''
107+
desc_ru: ''
108+
- name: head
109+
args: ''
110+
desc: ''
111+
desc_ru: ''
112+
- name: header
113+
args: 'name, value'
114+
desc: ''
115+
desc_ru: ''
116+
- name: headers
117+
args: 'headersMap'
118+
desc: ''
119+
desc_ru: ''
120+
- name: method
121+
args: 'method, requestBody = empty'
122+
desc: ''
123+
desc_ru: ''
124+
- name: newCall
125+
args: 'client'
126+
desc: creates new call, returns CallValue
127+
desc_ru: создаёт новый вызов, возвращает CallValue
128+
- name: patch
129+
args: 'requestBody = empty'
130+
desc: ''
131+
desc_ru: ''
132+
- name: post
133+
args: 'requestBody = empty'
134+
desc: ''
135+
desc_ru: ''
136+
- name: put
137+
args: 'requestBody = empty'
138+
desc: ''
139+
desc_ru: ''
140+
- name: removeHeader
141+
args: 'name'
142+
desc: ''
143+
desc_ru: ''
144+
- name: url
145+
args: 'url'
146+
desc: ''
147+
desc_ru: ''
148+
- name: RequestBodyValue
149+
functions:
150+
- name: bytes
151+
args: 'contentType, bytes, offset = 0, bytesCount = bytes.length'
152+
desc: ''
153+
desc_ru: ''
154+
- name: file
155+
args: 'contentType, filePath'
156+
desc: ''
157+
desc_ru: ''
158+
- name: string
159+
args: 'contentType, content'
160+
desc: ''
161+
desc_ru: ''
162+
- name: OkHttpValue
163+
constants:
164+
- name: client
165+
type: 4
166+
typeName: map
167+
value: HttpClientValue
168+
functions:
169+
- name: request
170+
args: ''
171+
desc: returns RequestBuilderValue
172+
desc_ru: возвращает RequestBuilderValue
173+
- name: HttpClientValue
174+
functions:
175+
- name: connectTimeoutMillis
176+
args: ''
177+
desc: ''
178+
desc_ru: ''
179+
- name: followRedirects
180+
args: ''
181+
desc: ''
182+
desc_ru: ''
183+
- name: followSslRedirects
184+
args: ''
185+
desc: ''
186+
desc_ru: ''
187+
- name: newCall
188+
args: 'request'
189+
desc: creates new call, returns CallValue
190+
desc_ru: создаёт новый вызов, возвращает CallValue
191+
- name: newWebSocket
192+
args: 'request, callbacks'
193+
desc: ''
194+
desc_ru: ''
195+
- name: pingIntervalMillis
196+
args: ''
197+
desc: ''
198+
desc_ru: ''
199+
- name: readTimeoutMillis
200+
args: ''
201+
desc: ''
202+
desc_ru: ''
203+
- name: retryOnConnectionFailure
204+
args: ''
205+
desc: ''
206+
desc_ru: ''
207+
- name: writeTimeoutMillis
208+
args: ''
209+
desc: ''
210+
desc_ru: ''

‎modules/main/src/main/java/com/annimon/ownlang/modules/okhttp/MultipartBodyBuilderValue.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import java.util.Map;
99
import okhttp3.MediaType;
1010
import okhttp3.MultipartBody;
11+
import okhttp3.RequestBody;
1112

1213
public class MultipartBodyBuilderValue extends MapValue {
1314

@@ -56,14 +57,14 @@ private Value addFormData(Value[] args) {
5657
}
5758

5859
private Value addPart(Value[] args) {
59-
Arguments.checkOrOr(2, 3, args.length);
60+
Arguments.checkOrOr(1, 2, args.length);
61+
RequestBody requestBody = Values.getRequestBody(args[0], " at first argument");
6062
if (args.length == 1) {
61-
builder.addPart(
62-
Values.getRequestBody(args[0], " at first argument"));
63+
builder.addPart(requestBody);
6364
} else {
6465
builder.addPart(
65-
Values.getHeaders(args[0], " at first argument"),
66-
Values.getRequestBody(args[1], " at second argument"));
66+
Values.getHeaders(args[1], " at second argument"),
67+
requestBody);
6768
}
6869
return this;
6970
}

0 commit comments

Comments
 (0)