frankframework / frank-doc

Frank!Doc
https://frankdoc.frankframework.org
Apache License 2.0
4 stars 5 forks source link

FrankDoc should show deprecation config warnings #184

Closed gvanbrakel closed 1 month ago

gvanbrakel commented 1 year ago

❗ please do not add sensitive information in issues, you can provide extra information via email using issue number as reference ❗

Describe the issue XmlFileIteratorPipe is deprecated, but the FrankDoc does not show the configuration warning, i.e. with what to replace it. That info is available, however, for instance in the javadoc See https://frankdoc.frankframework.org/#!/All/XmlFileElementIteratorPipe. See https://javadoc.frankframework.org/org/frankframework/pipes/XmlFileElementIteratorPipe.html

Reporter Gerrit

nielsm5 commented 1 month ago

ConfigurationWarning bij deprecated text moet in de fronted weergegeven worden

nielsm5 commented 1 month ago

Zowel de nieuwe metadata (forRemoval en since) alsook de ConfigurationWarning moet in de json terecht komen

@Deprecated(forRemoval = true, since = "7.6.0")
@ConfigurationWarning("Please replace with ForEachChildElementPipe. ElementName and elementChain can be replaced with containerElement and/or targetElement. It is not a 1 to 1 replacement, different values may be required!")
thomaspj10 commented 1 month ago

Adds the following information to the JSON data:

"deprecated": true,
"deprecationInfo": {
    "forRemoval": true,
    "since": "7.6.0",
    "configurationWarning": "Please replace with ForEachChildElementPipe. ElementName and elementChain can be replaced with containerElement and/or targetElement. It is not a 1 to 1 replacement, different values may be required!"
},

These fields are optional, because not every deprecated class or function has documented these values.

philipsens commented 1 month ago
"deprecated": {
    "forRemoval": true,
    "since": "7.6.0",
    "description": "Please replace with ForEachChildElementPipe. ElementName and elementChain can be replaced with containerElement and/or targetElement. It is not a 1 to 1 replacement, different values may be required!"
},
thomaspj10 commented 1 month ago

The metadata will be displayed like this:

Image Image