several issues with input.properties samples

[DinoChiesa]

Summary

I am looking at the input.properties sample, for SaaS assessment.
In general I'd like to see the input.properties example be as simple as possible, and easy to understand. There are a few things that do not contribute to clarity or simplicity:

1. There is a section entitled "topology". That feels like something that might be relevant to an OPDK assessment, but I'm not sure. It's not a term that will be familiar to Edge or X customers . It's not documented anywhere in the README for this tool. How is it relevant? I guess the main request here is to describe it, or ... if it is not relevant to SaaS assessment, remove this section from the sample input.properties file.
2. There is a setting or key/value pair like this: SOURCE_UI_URL=http://apigee.google ... what is the purpose of that? Is that supposed to be resolvable as a DNS name? The name of the variable implies that it has something to do with a UI. But why would the tool need to access the UI? I think we need documentation on this setting too, or maybe remove it if it is irrelevant.
3. Why do we need to specify GCP_ENV_TYPE ? What changes if I specify something other than "UNSPECIFIED" here?
4. Why is this setting present? API_URL=https://apidocs.apigee.com/docs I suppose that some of the output assessment report might include links to Google's documentation. But isn't the anchor point for that documentation always the same? Why should the API URL Root be a configurable thing? Do I ever need this? Maybe exclude it from the example file.
5. what is the difference between TARGET_DIR specified here in this file, and the volume mount of /app/target in the docker command? Are they the same thing? If so, what happens when I specify both?
6. Is there ever a case when I am going to want to not validate TLS when connecting to Edge SaaS or X ? I think the answer is no. I think SSL_VERIFICATION should be omitted from the sample input.properties file. The sample does not need to include every possible setting.
7. Does the format of this properties file allow comments? Maybe something prefixed with octothorpe? If so, I suggest you add comments and explanations in the sample files themselves. eg

   [inputs]
   # for OPDK, use the IP or endpoint of the management server
   SOURCE_URL=https://api.enterprise.apigee.com/v1
   SOURCE_ORG=sample-saas-project-1
   
   # auth type can be basic or oauth.
   SOURCE_AUTH_TYPE=oauth
   
   # no idea what this is
   SOURCE_UI_URL=http://apigee.google
   
   # is it necessary to specify this? If so, what are the options (describe HERE in
     the sample file)
     SOURCE_APIGEE_VERSION=SAAS
   
   # explain that DRZ URL can be used.
   TARGET_URL=https://apigee.googleapis.com/v1
   GCP_PROJECT_ID=sample-apigee-project-11
   
   # what are the options here and what happens if I change it or don't specify it?
   GCP_ENV_TYPE=ENVIRONMENT_TYPE_UNSPECIFIED
   API_URL=https://apidocs.apigee.com/docs
   
   # how does this relate to the -v option to the docker command?
   TARGET_DIR=target
   
   # Describe which things skip SSL verification if this is false
   SSL_VERIFICATION=true
   
   ...and so on...
   

Probably similar feedback applies to the sample input.properties files for OPDK and ... X?

[anaik91]

Simplified the input section to below format

[inputs]
SOURCE_URL=https://apigee.googleapis.com/v1
SOURCE_ORG=apigee-org-1234
SOURCE_AUTH_TYPE=oauth
SOURCE_APIGEE_VERSION=SAAS
TARGET_URL=https://apigee.googleapis.com/v1
GCP_PROJECT_ID=apigee-org-4321
GCP_ENV_TYPE=ENVIRONMENT_TYPE_UNSPECIFIED
TARGET_DIR=target
SSL_VERIFICATION=true

[anaik91]

Closing this post the input changes

[DinoChiesa]

So, no comments?

[anaik91]

@DinoChiesa : Missed that , adding comments