Skip to content

CSTM-191: Adding manifest validation for ui-plugin workspaces. Additionally, adding command with alias to just run validation for plugin manifest.#235

Open
jeremy-gooch-sp wants to merge 5 commits into
ui-pluginsfrom
CSTM-191
Open

CSTM-191: Adding manifest validation for ui-plugin workspaces. Additionally, adding command with alias to just run validation for plugin manifest.#235
jeremy-gooch-sp wants to merge 5 commits into
ui-pluginsfrom
CSTM-191

Conversation

@jeremy-gooch-sp

Copy link
Copy Markdown
Collaborator

Description

This PR adds ui-plugin model/manifest parsing and validation capabilities. It also adds a new sub-command for users to validate the structure of a plugin's manifest.

How Has This Been Tested?

Created and ran extensive unit tests. Also manually validated against an example sp-ui-plugin.json manifest file by testing missing required fields, invalid formats, and adding unspecified fields.

For quick reference, here's an example of a passing manifest file:

{
    "version": 1,
    "manifest": {
        "alias": "plugin-poc-playground",
        "name": {
            "en-US": "Plugin POC Playground"
        },
        "description": {
            "en-US": "Proof-of-concept UI plugin workspace for local development and manifest validation."
        },
        "apiScopes": [
            "sp:scopes:all"
        ],
        "permissionPolicy": {
            "geolocation": ["'self'"]
        },
        "iframeAllow": {
            "camera": ["'self'"]
        },
        "slots": [{
            "slotId": "full-page"
        }]
    },
    "build": {
        "outDir": "./",
        "port": 8080
    }
}

Base automatically changed from CSTM-190 to ui-plugins June 24, 2026 21:46
Comment thread cmd/ui_plugins/manifest_model.go Outdated
@@ -0,0 +1,35 @@
// Copyright (c) 2026, SailPoint Technologies, Inc. All rights reserved.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This code has the MIT license. I notice there are some existing files that add the copyright comment at the top, but it doesn't make sense to keep it here in an open-source repo. Same goes for all files in this PR.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, and good catch @jamie-perkins-sp. To be clear most of the repository (~70% according to claude) includes the same copyright comment. The files that don't include the header are scattered about and look more like outliers than anything intentional.

So, I'm curious if anyone on @developer-relations-sp has any insight into this or a preference for whether to include the copyright for consistency or drop it for this new feature set. Mentioned in PR review ticket: https://sailpoint.atlassian.net/browse/DEVREL-3001

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

As discussed this morning the copyright header has been dropped from the ui-plugins source files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants