Skip to content

Commit cf2b3c4

Browse files
ntrjpatelntrjpatel
committed
Updated readme
1 parent e969d56 commit cf2b3c4

1 file changed

Lines changed: 20 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ This library helps to generate TypeScript type definition for the content types
66

77
`$ npm install @contentstack/types-generator`
88

9-
109
## Migration
11-
Refer to the [Migration Guide](https://github.com/contentstack/types-generator/blob/main/MIGRATION.md) version 3 if you are migrating from version 2 or older.
1210

11+
Refer to the [Migration Guide](https://github.com/contentstack/types-generator/blob/main/MIGRATION.md) version 3 if you are migrating from version 2 or older.
1312

1413
## Usage
1514

@@ -33,17 +32,17 @@ This is an asynchronous method which generates Typescript type definition of the
3332

3433
**Input:**
3534

36-
| Property Name | Description | Data type | Accepted values | Mandatory | Default value |
37-
| -------------------- | ---------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------ | --------- | ------------- |
38-
| token | Unique identifier used for authorization | String | | Yes | |
39-
| tokenType | Type of token being provided (Currently we are supporting only delivery token) | String | delivery | Yes | |
40-
| apiKey | Stack API key | String | | Yes | |
41-
| environment | Name of the environment (example: development, staging, production) | String | | Yes | |
42-
| region | Contentstack API region | String | US (for AWS NA), EU (for AWS EU), AZURE_NA, AZURE_EU, GCP_NA | Yes | |
43-
| branch | Stack branch name | String | | No | |
44-
| prefix | Optional prefix to add for each interface | String | | No | |
45-
| includeDocumentation | To add content type documentation in the generated file | boolean | true, false | No | true |
46-
| systemFields | Boolean flag indicating whether to include system-generated fields in the response | boolean | true, false | No | false |
35+
| Property Name | Description | Data type | Accepted values | Mandatory | Default value |
36+
| -------------------- | ---------------------------------------------------------------------------------- | --------- | ----------------------------------------------------------------------------- | --------- | ------------- |
37+
| token | Unique identifier used for authorization | String | | Yes | |
38+
| tokenType | Type of token being provided (Currently we are supporting only delivery token) | String | delivery | Yes | |
39+
| apiKey | Stack API key | String | | Yes | |
40+
| environment | Name of the environment (example: development, staging, production) | String | | Yes | |
41+
| region | Contentstack API region | String | US (for AWS NA), EU (for AWS EU), AU (for AWS AU), AZURE_NA, AZURE_EU, GCP_NA | Yes | |
42+
| branch | Stack branch name | String | | No | |
43+
| prefix | Optional prefix to add for each interface | String | | No | |
44+
| includeDocumentation | To add content type documentation in the generated file | boolean | true, false | No | true |
45+
| systemFields | Boolean flag indicating whether to include system-generated fields in the response | boolean | true, false | No | false |
4746

4847
**Output:**
4948

@@ -169,14 +168,14 @@ This is an asynchronous method which generates Typescript type definition of the
169168

170169
**Input:**
171170

172-
| Property Name | Description | Data type | Accepted values | Mandatory |
173-
| ------------- | ----------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------ | --------- |
174-
| token | Unique identifier used for authorization. This should be the delivery token of the stack. | String | | Yes |
175-
| apiKey | Stack API key | String | | Yes |
176-
| environment | Name of the environment (example: development, staging, production) | String | | Yes |
177-
| region | Contentstack API region | String | US (for AWS NA), EU (for AWS EU), AZURE_NA, AZURE_EU, GCP_NA | Yes |
178-
| branch | Stack branch name | String | | No |
179-
| namespace | Identifies the specific namespace within schema | String | | No |
171+
| Property Name | Description | Data type | Accepted values | Mandatory |
172+
| ------------- | ----------------------------------------------------------------------------------------- | --------- | ----------------------------------------------------------------------------- | --------- |
173+
| token | Unique identifier used for authorization. This should be the delivery token of the stack. | String | | Yes |
174+
| apiKey | Stack API key | String | | Yes |
175+
| environment | Name of the environment (example: development, staging, production) | String | | Yes |
176+
| region | Contentstack API region | String | US (for AWS NA), EU (for AWS EU), AU (for AWS AU), AZURE_NA, AZURE_EU, GCP_NA | Yes |
177+
| branch | Stack branch name | String | | No |
178+
| namespace | Identifies the specific namespace within schema | String | | No |
180179

181180
**Output:**
182181

0 commit comments

Comments
 (0)