New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the web-api #238

Open

CThuleHansen opened this issue May 7, 2021 · 0 comments

Assignees

Contributor

CThuleHansen commented May 7, 2021

It is possible to document the web-api directly in code. Example:
https://github.com/INTO-CPS-Association/maestro/blob/development/maestro-webapi/src/main/java/org/intocps/maestro/webapi/maestro2/Maestro2SimulationController.java#L215-L217

which is outputted as:

Same can be carried out for data within the java json representation:

maestro/maestro-webapi/src/main/java/org/intocps/maestro/webapi/maestro2/dto/SimulateRequestBody.java

Lines 11 to 12 in bbad841

    
           @ApiModelProperty(value = "The start time of the co-simulation") 
        
           @JsonProperty("startTime")

Outputted as:

CThuleHansen assigned prasadtalasila

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment