Mwever/improvement/inline swagger docs#1038
Conversation
…rovement/inline-swagger-docs # Conflicts: # openml_OS/models/api/v1/Api_evaluation.php
…sible for handling the logic. Refactored bootstrapping for tag/untag of several entities as well as attach/detach to clearly distinct between different handlers. Fixed boolean types in annotations.
… type/ref for items.
… openapi specifications from inline php annotations.
|
Just checked in some scripts (bash and bat) for generating the OpenAPI specification from the PHP code annotations. It should all work by now. Just having some last tests with a clean clone of the branch (testing installation via composer and generation of the json/yaml files via the scripts. |
janvanrijn
left a comment
janvanrijn
left a comment
There was a problem hiding this comment.
I think the PR looks fine. Only thing that could be improved is removing the "flow_tag_untag" (run, data, setup, ..) functions, as these does not add anything immediately (and flow_tag and flow_untag) could call upon entity_tag_untag immediately.
…tion and added servers for base paths.
…is feature branch.
Removed unreferenced OpenAPI schemas.
|
@mwever shall we leave the tag_untag functions out? I agree with Jan that would be nicer. What do you think? |
joaquinvanschoren
left a comment
joaquinvanschoren
left a comment
There was a problem hiding this comment.
Looks good, but could you also make a README on how to produce the specification from this? And how other people should document new calls in the future? Or is there separate documentation about that elsewhere?
…in the classes two string constants are defined keeping the values for the super class providing the entity type and the entity special name.
… documentation with annotations within the PHP REST API.
|
tag_untag functions are now left out. I captured the duplicated values now with class constants. I also added now some documentation in terms of a readme file (in the openapi directory). Please check whether the documentation is sufficient and understandable, as I am too deep into that in order to estimate how understandable my explanations are. |
|
great, thanks! |
3 participants
Task: Annotate the backend API with swagger-php annotations so that we can generate a swagger.yaml/swagger.json from the inline documentation.
Current State: Added current documentation contained in the swagger.json/swagger.yaml from the downloads folder as inline documentation annotations to the API. Also added respective annotations for schemas.