Skip to content

Update the TOML file schemas #2677

@rodriin

Description

@rodriin

Description

Update the TOML file schemas to support Connect Cloud.

Create schema v4:

  • In the publishing record schema, make the following changes:
    • Allow server_type to be set to connect_cloud.
  • In the publishing schema, make the following changes:
    • Add the server_type field that's included in the publishing record schema. Connect-specific fields will be included only when server_type is connect, and vice versa with Connect Cloud.
    • Certain root-level fields will move into the connect object:
      • access
      • schedules (draft)
      • tags (draft)
    • Other fields will be conditionally excluded from the schema based on server_type, using JSON Schema oneOf:
      • has_parameters
      • python.package_file
      • python.package_manager
      • python.requires_python
      • r.package_file
      • r.package_manager
      • r.requires_r
      • jupyter.hide_all_input
      • jupyter.hide_tagged_input
      • quarto.version
      • quarto.engines
      • connect
    • Add a connect_cloud object field with the following subfields:
      • account_name
      • vanity_name
      • access.organization_access
      • access.public_access
    • Update the error handling to include field information from JSON Schema validation errors. (nice-to-have)
    • Running the publisher plugin a v3 schema file will automatically convert the schema file to v4.

Note: moving access from the root level into connect is the only breaking change. If we feel this change isn't important enough to warrant a new major schema version, we can keep the current version and conditionally allow the field when server_type is connect.

Metadata

Metadata

Assignees

Labels

apicloudConnect Cloud IntegrationjavascriptPull requests that update Javascript code

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions