Adding schema for server config and plugindefinition #812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sean Grady <[email protected]>
schema/config-schema.json
Outdated
| "tcpPort": { | ||
| "type": "integer", | ||
| "description": "TCP network port", | ||
| "minimum": 1, |
There was a problem hiding this comment.
better as 1024
schema/config-schema.json
Outdated
| "properties": { | ||
| "port": { | ||
| "$ref": "#/$defs/tcpPort", | ||
| "default": 8554 |
There was a problem hiding this comment.
but in v2 its 7556
schema/config-schema.json
Outdated
| }, | ||
| "secureOptions": { | ||
| "type": "integer", | ||
| "description": "Controls nodejs' use of OpenSSL via integers composed of the values in the references https://github.com/openssl/openssl/blob/master/include/openssl/ssl.h and https://nodejs.org/api/crypto.html#openssl-options" |
There was a problem hiding this comment.
schema/config-schema.json
Outdated
| "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" | ||
| }, | ||
| "ipOrHostname": { | ||
| "type": "string" |
There was a problem hiding this comment.
I have ipv4 right above so why not use it
schema/config-schema.json
Outdated
| "type": "object", | ||
| "properties": { | ||
| "port": { | ||
| "$ref": "#/$defs/tcpPort", |
There was a problem hiding this comment.
is this deprecated because zowe.yaml has a port too?
schema/plugindefinition-schema.json
Outdated
| "framework": { | ||
| "const": "iframe" | ||
| }, | ||
| "destination": { |
There was a problem hiding this comment.
oneOf... you can either have destination Or startingpage
| }, | ||
| "isSingleWindowApp": { | ||
| "type": "boolean", | ||
| "deprecated": true |
There was a problem hiding this comment.
should we omit this and just use AdditionalProperties:true
| "dependenciesIncluded": { | ||
| "type": "boolean", | ||
| "default": true, | ||
| "deprecated": true |
There was a problem hiding this comment.
again should we remove these?
| "const": "service" | ||
| }, | ||
| "initializerLookupMethod": { | ||
| "type": "string", |
There was a problem hiding this comment.
needs a description
| } | ||
| } | ||
| }, | ||
| "serviceService": { |
… properties, and added missing library plugin Signed-off-by: 1000TurquoisePogs <[email protected]>
1000TurquoisePogs
force-pushed
the
feature/schema
branch
from
d1e6472 to
35bf56f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: 1000turquoisepogs [email protected]
Proposed changes
This PR is related to #778 but #789 still needs to be decided upon, so these files could move again.
Type of change
Please delete options that are not relevant.
Testing
This still needs testing, as I'm unsure if this schema works as intended when it comes to adding properties on top of a $ref or having a catch-all properties pattern and then having exceptions for specifically-defined properties.
Further comments
These files may be further changed as we learn how they must be associated with the zowe base schema and zowe server infrastructure validation code in general (see zowe/zowe-install-packaging#2686 )
It could be that these files $ref the zowe base one in some way, and these files may even be wrapped in a few ways to fit into the manifest schema and server schema