delphix / virtualization-sdk

Delphix vSDK.
Apache License 2.0
7 stars 25 forks source link

Typo in Schemas-> referenceType section of the SDK documentation #371

Open vr-delphix opened 3 years ago

vr-delphix commented 3 years ago

Expected Behavior The referenceType section (https://developer.delphix.com/References/Schemas/#referencetype) in the SDK documentation has some typos here: Environment: UNIX_HOST_ENVIRONMENT Environment User: HOST_USER

This should actually be "UnixHostEnvironment" and "EnvironmentUser" instead of "UNIX_HOST_ENVIRONMENT" and "HOST_USER" respectively.

Actual Behavior When I ran dvp upload with a schema that uses "UNIX_HOST_ENVIRONMENT" and "HOST_USER", it fails like this: (venv) delphix@ip-10-110-199-101:~/qa-appdata-toolkits/toolkits/unix/direct/nix_direct_python$ dvp upload -e localhost -u admin --password delphix API request failed with HTTP Status 200 Details: {u'discoveryDefinition': {u'repositorySchema': {u'properties': {u'repoEnvUser': {u'"matches"': {u'action': None, u'diagnoses': None, u'commandOutput': None, u'details': u"The 'matches' keyword is only valid for the referenceType 'EnvironmentUser'.", u'id': u'exception.validation.matches.only.host.user'}, u'"referenceType"': {u'action': None, u'diagnoses': None, u'commandOutput': None, u'details': u'The string "HOST_USER" is not a valid reference type.', u'id': u'exception.validation.invalid.ref.type'}}, u'repoEnv': {u'"referenceType"': {u'action': None, u'diagnoses': None, u'commandOutput': None, u'details': u'The string "UNIX_HOST_ENVIRONMENT" is not a valid reference type.', u'id': u'exception.validation.invalid.ref.type'}}}}}} Action: Check your input parameters and try again.

Steps To Reproduce the Problem

  1. Add the referenceType fields in the plugin schema and run "dvp upload" cmd.

Screenshots If applicable, add screenshots to help explain your problem.

Version SDK 3.1.0

Additional Context Add any other context about the problem here, including additional logs or debugging information if appropriate.