Edit changelog messages

[reuvenharrison]

I suggest two changes to these messages:

1. display both orignal and new value
2. a nicer way to say it

for example:
the %s request property's maxLength was increased to %s
will become:
for the %s request property, maxLength was increased from '%s' to '%s'

Originally posted by @reuvenharrison in #345 (comment)

[blva]

We should think of how we can inform this to customers so they can update err/warn files, or maybe add a solution/script to update changed phrases.

[gcatanese]

@reuvenharrison What do you think about the option to pass a custom lang flag (i.e. my_labels) that it is used instead of the supported languages?
Developers could customise the labels/messages they want to use (effectively using the same key but deciding the value) and keeping it in a local folder (outside the tool).

Happy to contribute if you think this is a desired feature.

[reuvenharrison]

Hi @gcatanese
Sorry but I didn't understand the requirement.
Could you explain the goal?
What functionality are you looking for?

[gcatanese]

@reuvenharrison Sorry, what I meant is:

• pass a new value for the lang flag (--lang dir/myBundle), or better a new flag (--bundle dir/myBundle)
• myBundle is a file in the dir folder that contains a customised version of the messages and labels

request-body-added-required: new (required) Request Body
request-body-added-optional: new (optional) Request Body
request-parameter-removed: removed the %s Request Parameter %s
...

• OASDiff will use the messages and labels from myBundle when generating a report

The benefits are:

• developers can fully customise the messages generated in the report
• the custom file stays outside the OASDiff source code

[reuvenharrison]

Thanks for the clarification.
Why do you prefer this approach over the current mechanism?

[gcatanese]

I understood it is only possible to change the language.

Am I missing something? Is it already possible to override the messages without updating the source code?

[reuvenharrison]

In order to override one or more messages you would need to change the code.
Is that a problem?
The only reason I can think of to do it outside of the code is if you want a custom message per run.
But perhaps I am missing something...