Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Projects with several config entities can utilize the multi-file structure to organize config while keeping individual file sizes within manageable limits. The plugin requires the use of specific file names and directories to organize config (multi-file config). To make use of this structure, use the FDAPG_CONFIG_DIR_PATH project property.

├── api
│   ├── forecastweatherapi
│ │ ├── resourceFiles
│ │ │ ├── jsc
│ │ │ │ ├── test.js
│   │   ├── kvms.json
│   │   └── resourcefiles.json
│   └── oauth
│   ├── kvms.json
│   └── maskconfigs.json
├── env
│   ├── prod
│   │   ├── caches.json
│   │ └── flowhooks.json
│   └── test
│   ├── caches.json
│   ├── kvms.json
│   ├── targetServers.json
│ └── virtualHosts.json
│ └── references.json
│ └── keystores.json
│ └── aliases.json
└── org
├── apiProducts.json
├── developerApps.json
├── developers.json
├── kvms.json
├── companies.json
├── companyApps.json
├── reports.json
└── maskconfigs.json
└── userroles.json

...

Projects with fewer config entities can use the single file edge.json format to capture all configs of an API project. The edge.json file organizes config into 3 scopes corresponding to the scopes of config entities that can be created in Edge (single file config). The plugin looks for edge.json in the current directory by default FD_ARTIFACTS_DIR by default. If your config file is in a different directory, or the file is not names edge.json, use the FDAPG_CONFIG_FILE_PATH project property.

envConfig
orgConfig
apiConfig

...