Skip to content

Corrected property names and structure used in JSON schema generation for configuration of default data to install.#17946

Merged
nikolajlauridsen merged 1 commit intov13/devfrom
v13/bugfix/json-schema-install-default-data
Jan 13, 2025
Merged

Corrected property names and structure used in JSON schema generation for configuration of default data to install.#17946
nikolajlauridsen merged 1 commit intov13/devfrom
v13/bugfix/json-schema-install-default-data

Conversation

@AndyButland
Copy link
Contributor

Prerequisites

  • I have added steps to test this contribution in the description below

Addresses the issue raised here: #17945

Description

As reported in the linked issue, the JSON schema generation for the default data you can configure for install isn't correct.

When merged this PR will ensure that the JSON schema generated is correct and matches the paths used in code. This will correct the intellisense provided when configuring Umbraco.

To Test:

  • With the PR merged, rebuild the whole solution.
  • Verify the generated schema file found at src\Umbraco.Web.UI\appsettings-schema.Umbraco.Cms.json. You should now see the following elements:
  "InstallDefaultData": {
	  "$ref": "#/definitions/InstallDefaultDataNamedOptions"
  },
		
  "InstallDefaultDataNamedOptions": {
    "type": "object",
    "properties": {
      "Languages": {
        "$ref": "#/definitions/InstallDefaultDataSettings"
      },
      "DataTypes": {
        "$ref": "#/definitions/InstallDefaultDataSettings"
      },
      "MediaTypes": {
        "$ref": "#/definitions/InstallDefaultDataSettings"
      },
      "MemberTypes": {
        "$ref": "#/definitions/InstallDefaultDataSettings"
      }
    }
  },		
  • Edit the src\Umbraco.Web.UI\appSettings.json file in an IDE that supports intellisense for configuration, and create an InstallDefaultData element under Umbraco:Cms. Verify the options you are presented with via intellisense match the documented configuration.

… for configuration of default data to install.
Copy link
Contributor

@nikolajlauridsen nikolajlauridsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested with VS code and got intellisens 👍

@nikolajlauridsen nikolajlauridsen merged commit f2410f3 into v13/dev Jan 13, 2025
16 checks passed
@nikolajlauridsen nikolajlauridsen deleted the v13/bugfix/json-schema-install-default-data branch January 13, 2025 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Install Default Data Settings missing from appsettings-schema

3 participants