[
https://issues.apache.org/jira/browse/MRM-1997?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Martin Schreier updated MRM-1997:
---------------------------------
Description:
Swagger/OpenAPI is currently the de facto standard for documenting REST
interfaces. We should add it to our REST API documentation and maybe get rid of
all the different languages and examples for the different languages in our
REST documentation.
Enunciate is outdated, we use Swagger OpenAPI for documentation.
OpenAPI documentation is implemented by annotations the the service interfaces.
was:
Swagger/OpenAPI is currently the de facto standard for documenting REST
interfaces. We should add it to our REST API documentation and maybe get rid of
all the different languages and examples for the different languages in our
REST documentation.
enunciate seems to support swagger output so maybe this can be implemented
without too much effort.
Summary: Create Swagger and OpenAPI Documentation for REST Interface
and get rid of enunciate (was: Create Swagger and OpenAPI Documentation for
REST Interface and rework enunciate configuration.)
> Create Swagger and OpenAPI Documentation for REST Interface and get rid of
> enunciate
> ------------------------------------------------------------------------------------
>
> Key: MRM-1997
> URL: https://issues.apache.org/jira/browse/MRM-1997
> Project: Archiva
> Issue Type: Task
> Reporter: Martin Schreier
> Assignee: Martin Schreier
> Priority: Major
> Fix For: 3.0.0
>
>
> Swagger/OpenAPI is currently the de facto standard for documenting REST
> interfaces. We should add it to our REST API documentation and maybe get rid
> of all the different languages and examples for the different languages in
> our REST documentation.
> Enunciate is outdated, we use Swagger OpenAPI for documentation.
> OpenAPI documentation is implemented by annotations the the service
> interfaces.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
