Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
Application Packaging
REST API Documentation (Swagger)
...
- Creates a tag for the class so that all API's underneath a class are grouped together
- Searches through each method looking for API methods and documenting
- Method type (Get, Post, Put, Delete), summary, description, tags (which class it belongs to)
- Parameters: in (Path, Query, or Body), descriptions, type (String, integer, number, boolean), required
- Swagger json schema: @onos.rsModel <Json_schema_file_name_without_extension> javadoc annotation and a .json schema file with the same name is in in the dircrectory <app_path>/src/main/resources/definitions. An example can be seen with the DHCP app.
- Responses: Types of response codes returned and their associated meanings
- Produces/consumes: application type returned or consumed by the API (ex. "application/json")
...
The OnosSwaggerMojo can be used to generate Swagger compliant documentation for any REST API that applications on top of ONOS provide.
...