Skip to content

Commit

Permalink
docs: fox format
Browse files Browse the repository at this point in the history
  • Loading branch information
@koba04
koba04 committed Feb 13, 2020
1 parent 7fb0226 commit f42b499
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/rest-api-client/docs/app.md
View file
Expand Up @@ -188,7 +188,7 @@ Adds fields to a form of an app.
| properties.{fieldCode}.minValue | Number | | The minimum value for the field. |
| properties.{fieldCode}.maxLength | Number | | The maximum number of characters for the field. |
| properties.{fieldCode}.minLength | Number | | The minimum number of characters for the field. |
| properties.{fieldCode}.defaultValue | String or Array | | The default value.<br /> For fields that can set multiple default values, specify the value as an array.<br /> The `defaultNowValue` will take priority if it also specified. |
| properties.{fieldCode}.defaultValue | String or Array | | The default value.<br /> For fields that can set multiple default values, specify the value as an array.<br /> The `defaultNowValue` will take priority if it also specified. |
| properties.{fieldCode}.defaultNowValue | Boolean | | The "Default to the record creation date" option. It indicates whether the record creation date will be used as the default value. <br /> If ignored, this value is `false`. |
| properties.{fieldCode}.options | Object | Conditionally<br />Required | An object including data of the field's options. Required for fields that have multiple options, such as radio button fields. |
| properties.{fieldCode}.options.{optionName} | Object | Conditionally<br />Required | An object with data of the settings of the options.<br />Specify the option name for this parameter.<br />Required, if the `options` parameter is specified. |
Expand All @@ -210,7 +210,7 @@ Adds fields to a form of an app.
| properties.{fieldCode}.referenceTable | Object | Conditionally<br />Required | An object containing the settings of the related records field.<br />Required for related record fields. |
| properties.{fieldCode}.referenceTable.relatedApp | Object | Conditionally<br />Required | An object containing data of the "Datasource App" setting.<br />Required, if the `referenceTable` parameter is specified. |
| properties.{fieldCode}.referenceTable.relatedApp.app | Number | Conditionally<br />Required | The app ID of the datasource app.<br />If the `relatedApp` parameter is specified, either this parameter or properties.`{fieldCode}.referenceTable.relatedApp.code` will be required.<nr />If both parameters are set, `properties.{fieldCode}.referenceTable.relatedApp.code` will take priority. |
| properties.{fieldCode}.referenceTable.relatedApp.code | String | Conditionally<br />Required | The app code of the datasource app.<br />If the `relatedApp` parameter is specified, either this parameter or properties.`{fieldCode}.referenceTable.relatedApp.app` will be required.<br />If both parameters are set, `properties.{fieldCode}.referenceTable.relatedApp.code` will take priority. |
| properties.{fieldCode}.referenceTable.relatedApp.code | String | Conditionally<br />Required | The app code of the datasource app.<br />If the `relatedApp` parameter is specified, either this parameter or properties.`{fieldCode}.referenceTable.relatedApp.app` will be required.<br />If both parameters are set, `properties.{fieldCode}.referenceTable.relatedApp.code` will take priority. |
| properties.{fieldCode}.referenceTable.condition | Object | Conditionally<br />Required | An object containing data of the "Fetch Criteria" setting.<br />Required, if the `referenceTable` parameter is specified. |
| properties.{fieldCode}.referenceTable.condition.field | String | Conditionally<br />Required | The field code of the field selected for "Field in this app".<br />Required, if the `referenceTable` parameter is specified. |
| properties.{fieldCode}.referenceTable.condition.relatedField | String | Conditionally<br />Required | The field code of the field selected for "Field in datasource app".<br />Required, if the `referenceTable` parameter is specified. |
Expand Down

0 comments on commit f42b499

Please sign in to comment.