Skip to content

Update EDM boilerplate #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gasperzgonec merged 1 commit into from
Jan 7, 2026
Merged

Update EDM boilerplate #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions templates/external_domain_metadata_boilerplate.plain
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
***Definitions:***

- The structure of :ExternalDomainMetadataJSONObject: is specified by the JSON schema defined in the resource [external_domain_metadata_schema.json](external_domain_metadata_schema.json).
- :ExternalDomainMetadataJSONObjectStructure: is the structure of :ExternalDomainMetadataJSONObject: is specified by the JSON schema defined in the resource [external_domain_metadata_schema.json](external_domain_metadata_schema.json).
- Please note that all refers_to keys in reference and typed_reference fields must use the format "#record:<record_type_key>", where <record_type_key> matches a key in the top-level record_types. This ensures references are unambiguous and valid. Use {} as the value to refer by default identifier (id), or specify { "by_field": "field_name" } to use a custom key.

- A “display name” is the human-readable label of a field within a given record type.
- :ExternalDomainMetadataJSONObjectDisplayName: is the display name (human-readable label) of a field within a given record type.

***Non-Functional Requirements:***

Expand All @@ -15,6 +15,10 @@

***Test Requirements:***

- Set timeout for each test to 30 seconds.

- :ConformanceTests: should print the EDM to the console.

- Validate generated :ExternalDomainMetadataJSONObject: with :ChefCLI: using the command "${CHEF_CLI_PATH} validate-metadata":
- This command reads JSON object from stdin.
- The path to :ChefCLI: executable is provided in the environment variables `CHEF_CLI_PATH`.
Expand All @@ -23,8 +27,7 @@

- :ExternalDomainMetadataJSONObject: *MUST* be validated solely against :ChefCLI:.
- You *MUST NOT* validate :ExternalDomainMetadataJSONObject: against the literal JSON contents of :ExternalDomainMetadataJSONObject:.
- :ConformanceTests: should have *ONLY TWO* tests
- That :Function: returning :ExternalDomainMetadataJSONObject: can be invoked successfully
- :ConformanceTests: should have *ONLY ONE* test
- :ChefCLI: validation using the command "${CHEF_CLI_PATH} validate-metadata"

- :ExternalDomainMetadataJSONObject: should always be read from :Implementation: (and not recreated in :ConformanceTests:)
Expand Down