Skip to content

Commit aee438c

Browse files
authored
feat: Remove source code mentions (#397)
1 parent 68f6284 commit aee438c

File tree

1 file changed

+36
-30
lines changed

1 file changed

+36
-30
lines changed

content/docs/api_v2/api_v2_reference.apib

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -562,13 +562,6 @@ The `sourceType` property indicates where the source code is hosted, and based
562562
on its value the Version object has the following additional property:
563563

564564
<table>
565-
<tr>
566-
<td><code>"SOURCE_CODE"</code></td>
567-
<td>
568-
Source code is a single JavaScript/Node.js file whose content is in the <code>sourceCode</code> field,
569-
and uses a base Docker image specified in <code>baseDockerImage</code>.
570-
</td>
571-
</tr>
572565
<tr>
573566
<td><code>"SOURCE_FILES"</code></td>
574567
<td>
@@ -3786,7 +3779,7 @@ The user account is identified by the provided authentication token.
37863779

37873780
## Version (object)
37883781
- versionNumber: `0.0` (string, required)
3789-
- sourceType: `SOURCE_CODE` (VersionSourceType, required)
3782+
- sourceType: `SOURCE_FILES` (VersionSourceType, required)
37903783
- envVars (array, nullable)
37913784
- (object)
37923785
- name: `DOMAIN` (string, required)
@@ -3795,10 +3788,25 @@ The user account is identified by the provided authentication token.
37953788
- (object)
37963789
- name: `SECRET_PASSWORD` (string, required)
37973790
- isSecret: true (boolean, nullable)
3798-
- baseDockerImage: `apify/actor-node-basic` (string, nullable)
37993791
- applyEnvVarsToBuild: false (boolean, nullable)
38003792
- buildTag: `latest` (string, required)
3801-
- sourceCode: `console.log('Hello world!');` (string, nullable)
3793+
- sourceFiles (array)
3794+
-(object)
3795+
- name: `src/main.js` (string, required)
3796+
- format: `TEXT` (string, required)
3797+
- content: `console.log('This is the main.js file');` (string, required)
3798+
-(object)
3799+
- name: `package.json` (string, required)
3800+
- format: `TEXT` (string, required)
3801+
- content: `name: "My Scraper"` (string, required)
3802+
-(object)
3803+
- name: `Dockerfile` (string, required)
3804+
- format: `TEXT` (string, required)
3805+
- content: ` # Dockerfile contains instructions ...` (string, required)
3806+
-(object)
3807+
- name: `README.md` (string, required)
3808+
- format: `TEXT` (string, required)
3809+
- content: `My Actor scrapes the web` (string, required)
38023810

38033811
## EnvVar (object)
38043812
- name: `MY_ENV_VAR` (string, required)
@@ -3824,26 +3832,10 @@ The user account is identified by the provided authentication token.
38243832
- isSecret: true (boolean, nullable)
38253833

38263834
## ListOfVersions (array)
3827-
- (object)
3828-
- versionNumber: `0.0` (string, required)
3829-
- sourceType: `SOURCE_CODE` (VersionSourceType, required)
3830-
- envVars (array, nullable)
3831-
- (object)
3832-
- name: `DOMAIN` (string, required)
3833-
- value: `http://example.com` (string, required)
3834-
- isSecret: false (boolean, nullable)
3835-
- (object)
3836-
- name: `SECRET_PASSWORD` (string, required)
3837-
- isSecret: true (boolean, nullable)
3838-
- baseDockerImage: `apify/actor-node-basic` (string, nullable)
3839-
- applyEnvVarsToBuild: false (boolean, nullable)
3840-
- buildTag: `latest` (string, required)
3841-
- sourceCode: `console.log('Hello world!');` (string, nullable)
38423835
- (object)
38433836
- versionNumber: `0.1` (string, required)
38443837
- envVars: [] (array, nullable)
38453838
- sourceType: `SOURCE_FILES` (VersionSourceType, required)
3846-
- sourceCode: `console.log('Hello world!');` (string, nullable)
38473839
- applyEnvVarsToBuild: false (boolean, nullable)
38483840
- buildTag: `latest` (string, required)
38493841
- sourceFiles (array)
@@ -3888,7 +3880,7 @@ The user account is identified by the provided authentication token.
38883880

38893881
## VersionUpdate (object)
38903882
- versionNumber: `0.0` (string, nullable)
3891-
- sourceType: `SOURCE_CODE` (VersionSourceType, nullable)
3883+
- sourceType: `SOURCE_FILES` (VersionSourceType, nullable)
38923884
- envVars (array, nullable)
38933885
- (object)
38943886
- name: `DOMAIN` (string, nullable)
@@ -3898,13 +3890,27 @@ The user account is identified by the provided authentication token.
38983890
- name: `SECRET_PASSWORD` (string, nullable)
38993891
- value: `MyTopSecretPassword123` (string, nullable)
39003892
- isSecret: true (boolean, nullable)
3901-
- baseDockerImage: `apify/actor-node-basic` (string, nullable)
39023893
- applyEnvVarsToBuild: false (boolean, nullable)
39033894
- buildTag: `latest` (string, nullable)
3904-
- sourceCode: `console.log('Hello world!');` (string, nullable)
3895+
- sourceFiles (array)
3896+
-(object)
3897+
- name: `src/main.js` (string, required)
3898+
- format: `TEXT` (string, required)
3899+
- content: `console.log('This is the main.js file');` (string, required)
3900+
-(object)
3901+
- name: `package.json` (string, required)
3902+
- format: `TEXT` (string, required)
3903+
- content: `name: "My Scraper"` (string, required)
3904+
-(object)
3905+
- name: `Dockerfile` (string, required)
3906+
- format: `TEXT` (string, required)
3907+
- content: ` # Dockerfile contains instructions ...` (string, required)
3908+
-(object)
3909+
- name: `README.md` (string, required)
3910+
- format: `TEXT` (string, required)
3911+
- content: `My Actor scrapes the web` (string, required)
39053912

39063913
## VersionSourceType (enum)
3907-
+ `SOURCE_CODE`
39083914
+ `SOURCE_FILES`
39093915
+ `GIT_REPO`
39103916
+ `TARBALL`

0 commit comments

Comments
 (0)