[jira] [Updated] (CAMEL-21731) camel-openapi-java - Adding reference to external Open API docs

["Claus Ibsen (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/CAMEL-21731?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Claus Ibsen updated CAMEL-21731:
--------------------------------
    Summary: camel-openapi-java - Adding reference to external Open API docs  (was: Adding Open API Specifications)

> camel-openapi-java - Adding reference to external Open API docs
> ---------------------------------------------------------------
>
>                 Key: CAMEL-21731
>                 URL: https://issues.apache.org/jira/browse/CAMEL-21731
>             Project: Camel
>          Issue Type: New Feature
>          Components: camel-openapi-java
>    Affects Versions: 4.3.0
>            Reporter: John Cody
>            Priority: Minor
>
> Part of the [Open API specifications | https://spec.openapis.org/oas/v3.1.0.html#external-documentation-object] allows for an externalDocs object with a description and a URI.  
> {code:java}
> externalDocs: { 
>     "description": "Find more info here", 
>     "url": "https://example.com" 
> },{code}
> Currently the Java first implementation of the camel-openapi-java doesn't support this type of documentation when added to the REST Component.  It would be good to have this ability in our Open API specifications so that we could link to other documentation like a wiki or some sort of knowledge base for the API.
> Here is an example of what it might look like.
>  
> {code:java}
> restConfiguration().component("servlet") 
>     ... 
>     .apiExternalDocs("This is a cool API", "http://thisisacoolapi/docs.html") 
>     ...;{code}



--
This message was sent by Atlassian Jira
(v8.20.10#820010)