Skip to content

Commit 5a58938

Browse files
fnesvedafnesveda
authored
Fix malformed API docs (#405)
1 parent 0a010de commit 5a58938

File tree

1 file changed

+37
-40
lines changed

1 file changed

+37
-40
lines changed

‎content/docs/api_v2/api_v2_reference.apib

Lines changed: 37 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3535,14 +3535,14 @@ Gets the schedule log as a JSON array containing information about up to a 1000
35353535
+ Attributes
35363536
- data (array, required)
35373537
- (object, required)
3538-
- message `Schedule invoked` (string, required)
3539-
- level `INFO` (string, required)
3540-
- createdAt `2019-03-26T12:28:00.370Z` (string, required)
3538+
- message: `Schedule invoked` (string, required)
3539+
- level: `INFO` (string, required)
3540+
- createdAt: `2019-03-26T12:28:00.370Z` (string, required)
35413541

35423542
- (object, required)
3543-
- message `Cannot start actor task \"iEvfA6pm6DWjRTGxS\": Provided input must be object, got \"string\" instead.` (string, required)
3544-
- level `ERROR` (string, required)
3545-
- createdAt `2019-03-26T12:30:00.325Z` (string, required)
3543+
- message: `Cannot start actor task \"iEvfA6pm6DWjRTGxS\": Provided input must be object, got \"string\" instead.` (string, required)
3544+
- level: `ERROR` (string, required)
3545+
- createdAt: `2019-03-26T12:30:00.325Z` (string, required)
35463546

35473547
# Group Logs
35483548

@@ -3626,7 +3626,6 @@ The user account is identified by the provided authentication token.
36263626
- description: `My favourite actor!` (string, nullable)
36273627
- restartOnError: false (boolean, nullable)
36283628
- isPublic: false (boolean, required)
3629-
- isAnonymouslyRunnable: false (boolean, nullable)
36303629
- createdAt: `2019-07-08T11:27:57.401Z` (string, required)
36313630
- modifiedAt: `2019-07-08T14:01:05.546Z` (string, required)
36323631
- stats (object, required)
@@ -3660,36 +3659,34 @@ The user account is identified by the provided authentication token.
36603659
- description: `My favourite actor!` (string, nullable)
36613660
- title: `My actor` (string, nullable)
36623661
- isPublic: false (boolean, nullable)
3663-
- categories [] (array, nullable)
3664-
- seoTitle `My actor` (string, nullable)
3665-
- seoDescription `My actor is the best` (string, nullable)
3666-
- isAnonymouslyRunnable false (boolean, nullable)
3667-
- issuesEnabled true (boolean, nullable)
3662+
- seoTitle: `My actor` (string, nullable)
3663+
- seoDescription: `My actor is the best` (string, nullable)
3664+
- issuesEnabled: true (boolean, nullable)
36683665
- restartOnError: false (boolean, nullable)
36693666
- versions (array, nullable)
36703667
- (VersionUpdate, nullable)
3668+
- categories (array[string], nullable)
36713669
- defaultRunOptions (object, nullable)
36723670
- build: `latest` (string, required)
36733671
- timeoutSecs: 3600 (number, required)
3674-
- memoryMbytes: 2048 (number, required)
3672+
- memoryMbytes: 2048 (number, required)
36753673

36763674
## ActUpdate (object)
36773675
- name: `MyActor` (string, required)
36783676
- description: `My favourite actor!` (string, nullable)
36793677
- isPublic: false (boolean, required)
3680-
- categories [] (array, nullable)
3681-
- seoTitle `My actor` (string, nullable)
3682-
- seoDescription `My actor is the best` (string, nullable)
3683-
- isAnonymouslyRunnable false (boolean, nullable)
3684-
- issuesEnabled true (boolean, nullable)
3678+
- seoTitle: `My actor` (string, nullable)
3679+
- seoDescription: `My actor is the best` (string, nullable)
3680+
- issuesEnabled: true (boolean, nullable)
36853681
- title: `My Actor` (string, nullable)
36863682
- restartOnError: false (boolean, nullable)
36873683
- versions (array, required)
36883684
- (VersionUpdate, required)
3685+
- categories (array[string], nullable)
36893686
- defaultRunOptions (object, nullable)
36903687
- build: `latest` (string, required)
36913688
- timeoutSecs: 3600 (number, required)
3692-
- memoryMbytes: 2048 (number, required)
3689+
- memoryMbytes: 2048 (number, required)
36933690

36943691
## ActorShort1 (object)
36953692
- id: `br9CKmk457` (string, required)
@@ -3834,7 +3831,7 @@ The user account is identified by the provided authentication token.
38343831
## ListOfVersions (array)
38353832
- (object)
38363833
- versionNumber: `0.1` (string, required)
3837-
- envVars: [] (array, nullable)
3834+
- envVars: (array, nullable)
38383835
- sourceType: `SOURCE_FILES` (VersionSourceType, required)
38393836
- applyEnvVarsToBuild: false (boolean, nullable)
38403837
- buildTag: `latest` (string, required)
@@ -3858,21 +3855,21 @@ The user account is identified by the provided authentication token.
38583855
- (object)
38593856
- versionNumber: `0.2` (string, required)
38603857
- sourceType: `GIT_REPO` (VersionSourceType, required)
3861-
- envVars: [] (array, nullable)
3858+
- envVars: (array, nullable)
38623859
- applyEnvVarsToBuild: false (boolean, nullable)
38633860
- buildTag: `latest` (string, required)
38643861
- gitRepoUrl: `https://github.com/jane35/my-actor` (string, required)
38653862
- (object)
38663863
- versionNumber: `0.3` (string, required)
38673864
- sourceType: `TARBALL` (VersionSourceType, required)
3868-
- envVars: [] (array, nullable)
3865+
- envVars: (array, nullable)
38693866
- applyEnvVarsToBuild: false (boolean, nullable)
38703867
- buildTag: `latest` (string, required)
38713868
- tarballUrl: `https://github.com/jane35/my-actor/archive/master.zip` (string, required)
38723869
- (object)
38733870
- versionNumber: `0.4` (string, required)
38743871
- sourceType: `GITHUB_GIST` (VersionSourceType, required)
3875-
- envVars: [] (array, nullable)
3872+
- envVars: (array, nullable)
38763873
- applyEnvVarsToBuild: false (boolean, nullable)
38773874
- buildTag: `latest` (string, required)
38783875
- gitHubGistUrl: `https://gist.github.com/jane35/e51feb784yu89` (string, required)
@@ -3960,21 +3957,21 @@ The user account is identified by the provided authentication token.
39603957
- origin: `API` (string, required)
39613958

39623959
## BuildAborted (object)
3963-
- id: `HG7ML7M8z78YcAPEB` (string, required)
3964-
- actId: `janedoe~my-actor` (string, required)
3965-
- userId: `klmdEpoiojmdEMlk3` (string, required)
3966-
- startedAt: `2019-11-30T07:34:24.202Z` (string, required)
3967-
- finishedAt: `2019-12-12T09:30:12.202Z` (string, nullable)
3968-
- status: `ABORTED` (string, required)
3969-
- meta (object, required)
3970-
- origin: `WEB` (string, required)
3971-
- stats (object, nullable)
3972-
- durationMillis 1000 (number, required)
3973-
- runTimeSecs: 5.718 (number, required)
3974-
- options (object, nullable)
3975-
- useCache: false (boolean, nullable)
3976-
- memoryMbytes: 1024 (number, nullable)
3977-
- diskMbytes: 2048 (number, nullable)
3960+
- id: `HG7ML7M8z78YcAPEB` (string, required)
3961+
- actId: `janedoe~my-actor` (string, required)
3962+
- userId: `klmdEpoiojmdEMlk3` (string, required)
3963+
- startedAt: `2019-11-30T07:34:24.202Z` (string, required)
3964+
- finishedAt: `2019-12-12T09:30:12.202Z` (string, nullable)
3965+
- status: `ABORTED` (string, required)
3966+
- meta (object, required)
3967+
- origin: `WEB` (string, required)
3968+
- stats (object, nullable)
3969+
- durationMillis: 1000 (number, required)
3970+
- runTimeSecs: 5.718 (number, required)
3971+
- options (object, nullable)
3972+
- useCache: false (boolean, nullable)
3973+
- memoryMbytes: 1024 (number, nullable)
3974+
- diskMbytes: 2048 (number, nullable)
39783975

39793976
## Run (object)
39803977
- id: `HG7ML7M8z78YcAPEB` (string, required)
@@ -4299,15 +4296,15 @@ The user account is identified by the provided authentication token.
42994296
- uniqueKey: `http://example.com` (string, required)
43004297
- url: `http://example.com` (string, required)
43014298
- method: `GET` (string, required)
4302-
- loadedUrl `http://example.com/example-1` (object, nullable)
4299+
- loadedUrl: `http://example.com/example-1` (string, nullable)
43034300
- payload (object, nullable)
43044301
- noRetry: false (boolean, nullable)
43054302
- errorMessages (array, nullable)
43064303
- headers (object, nullable)
43074304
- userData (object)
43084305
- label: `DETAIL` (string, nullable)
43094306
- image: `https://picserver1.eu` (string, nullable)
4310-
- handledAt `2019-06-16T10:23:31.607Z` (object, nullable)
4307+
- handledAt: `2019-06-16T10:23:31.607Z` (object, nullable)
43114308

43124309
## UserPublicInfo (object)
43134310
- username: `d7b9MDYsbtX5L7XAj` (string, required)

0 commit comments

Comments
 (0)