generate docs for models and APIs

All models and API methods updated to have docstrings as specified in the k8s swagger spec.
Makes use of recent update to Swagger.jl for generatng docstrings for models and apis (JuliaComputing/Swagger.jl#48).

Author: tanmaykm

gen/gentypealiases.jl

@@ -47,8 +47,14 @@ function kuberapitypes(file::String, aliases_set::KuberTypeAliasesSet)
     api_decoration = ""
 
     while !ps.done
+        structsig = nothing
         if CSTParser.defines_struct(x)
             structsig = CSTParser.get_sig(x)
+        elseif x.typ == CSTParser.MacroCall && CSTParser.str_value(x[1]) == "@doc"
+            structsig = CSTParser.get_sig(x[3])
+        end
+
+        if structsig !== nothing
             if structsig.typ === CSTParser.BinaryOpCall
                 op = structsig.args[2]
                 if CSTParser.is_issubt(op)
@@ -105,8 +111,14 @@ function kubermodeltypes(file::String, sorted_apis::Vector{String}, aliases_set:
     x, ps = CSTParser.parse(ParseState(String(readchomp(file))))
 
     while !ps.done
+        structsig = nothing
         if CSTParser.defines_struct(x)
             structsig = CSTParser.get_sig(x)
+        elseif x.typ == CSTParser.MacroCall && CSTParser.str_value(x[1]) == "@doc"
+            structsig = CSTParser.get_sig(x[3])
+        end
+
+        if structsig !== nothing
             model_name = CSTParser.str_value(CSTParser.get_name(structsig.args[1]))
             if !startswith(model_name, "IoK8sKubernetes") && !(model_name == "IoK8sApimachineryPkgRuntimeRawExtension")
                 api_idx = find_matching_api(sorted_apis, model_name)

src/api/api_AdmissionregistrationApi.jl

@@ -5,18 +5,18 @@ struct AdmissionregistrationApi <: SwaggerApi
     client::Swagger.Client
 end
 
-"""
-
-get information of a group
-Return: IoK8sApimachineryPkgApisMetaV1APIGroup
-"""
 function _swaggerinternal_getAdmissionregistrationAPIGroup(_api::AdmissionregistrationApi; _mediaType=nothing)
     _ctx = Swagger.Ctx(_api.client, "GET", IoK8sApimachineryPkgApisMetaV1APIGroup, "/apis/admissionregistration.k8s.io/", ["BearerToken"])
     Swagger.set_header_accept(_ctx, ["application/json", "application/yaml", "application/vnd.kubernetes.protobuf"])
     Swagger.set_header_content_type(_ctx, (_mediaType === nothing) ? ["application/json", "application/yaml", "application/vnd.kubernetes.protobuf"] : [_mediaType])
     return _ctx
 end
 
+"""
+
+get information of a group
+Return: IoK8sApimachineryPkgApisMetaV1APIGroup
+"""
 function getAdmissionregistrationAPIGroup(_api::AdmissionregistrationApi; _mediaType=nothing)
     _ctx = _swaggerinternal_getAdmissionregistrationAPIGroup(_api; _mediaType=_mediaType)
     Swagger.exec(_ctx)

src/api/api_AdmissionregistrationV1Api.jl

@@ -5,18 +5,18 @@ struct ApiextensionsApi <: SwaggerApi
     client::Swagger.Client
 end
 
-"""
-
-get information of a group
-Return: IoK8sApimachineryPkgApisMetaV1APIGroup
-"""
 function _swaggerinternal_getApiextensionsAPIGroup(_api::ApiextensionsApi; _mediaType=nothing)
     _ctx = Swagger.Ctx(_api.client, "GET", IoK8sApimachineryPkgApisMetaV1APIGroup, "/apis/apiextensions.k8s.io/", ["BearerToken"])
     Swagger.set_header_accept(_ctx, ["application/json", "application/yaml", "application/vnd.kubernetes.protobuf"])
     Swagger.set_header_content_type(_ctx, (_mediaType === nothing) ? ["application/json", "application/yaml", "application/vnd.kubernetes.protobuf"] : [_mediaType])
     return _ctx
 end
 
+"""
+
+get information of a group
+Return: IoK8sApimachineryPkgApisMetaV1APIGroup
+"""
 function getApiextensionsAPIGroup(_api::ApiextensionsApi; _mediaType=nothing)
     _ctx = _swaggerinternal_getApiextensionsAPIGroup(_api; _mediaType=_mediaType)
     Swagger.exec(_ctx)

src/api/api_AdmissionregistrationV1beta1Api.jl

@@ -5,18 +5,18 @@ struct ApiregistrationApi <: SwaggerApi
     client::Swagger.Client
 end
 
-"""
-
-get information of a group
-Return: IoK8sApimachineryPkgApisMetaV1APIGroup
-"""
 function _swaggerinternal_getApiregistrationAPIGroup(_api::ApiregistrationApi; _mediaType=nothing)
     _ctx = Swagger.Ctx(_api.client, "GET", IoK8sApimachineryPkgApisMetaV1APIGroup, "/apis/apiregistration.k8s.io/", ["BearerToken"])
     Swagger.set_header_accept(_ctx, ["application/json", "application/yaml", "application/vnd.kubernetes.protobuf"])
     Swagger.set_header_content_type(_ctx, (_mediaType === nothing) ? ["application/json", "application/yaml", "application/vnd.kubernetes.protobuf"] : [_mediaType])
     return _ctx
 end
 
+"""
+
+get information of a group
+Return: IoK8sApimachineryPkgApisMetaV1APIGroup
+"""
 function getApiregistrationAPIGroup(_api::ApiregistrationApi; _mediaType=nothing)
     _ctx = _swaggerinternal_getApiregistrationAPIGroup(_api; _mediaType=_mediaType)
     Swagger.exec(_ctx)