github.com/GoogleContainerTools/skaffold@v1.39.18/proto/v1/markdown.tmpl (about)

     1  ---
     2  title: "gRPC API"
     3  linkTitle: "gRPC API"
     4  weight: 30
     5  ---
     6  <!--
     7  ******
     8  WARNING!!!
     9  
    10  The file docs/content/en/docs/references/api/grpc.md is generated based on proto/markdown.tmpl,
    11  and generated with ./hack/generate_proto.sh!
    12  Please edit the template file and not the markdown one directly!
    13  
    14  ******
    15  -->
    16  This is a generated reference for the [Skaffold API]({{"{{"}}<relref "/docs/design/api">{{"}}"}}) gRPC layer.
    17  
    18  We also generate the [reference doc for the HTTP layer]({{"{{"}}<relref "/docs/references/api/swagger">{{"}}"}}).
    19  
    20  {{range .Files}}
    21  {{$file_name := .Name}}
    22  <a name="{{.Name}}"></a>
    23  
    24  ## {{.Name}}
    25  
    26  You can find the source for {{.Name}} [on Github](https://github.com/GoogleContainerTools/skaffold/blob/main/proto/v1/{{.Name}}).
    27  
    28  {{.Description}}
    29  
    30  ### Services
    31  {{range .Services}}
    32  <a name="{{.FullName}}"></a>
    33  
    34  #### {{.Name}}
    35  {{.Description}}
    36  
    37  | Method Name | Request Type | Response Type | Description |
    38  | ----------- | ------------ | ------------- | ------------|
    39  {{range .Methods -}}
    40      | {{.Name}} | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} |
    41  {{end}}
    42  {{end}} <!-- end services -->
    43  
    44  
    45  ### Data types
    46  
    47  {{range .Messages}}
    48  
    49  <a name="{{.FullName}}"></a>
    50  #### {{.LongName}}
    51  {{.Description}}
    52  
    53  {{if .HasFields}}
    54  | Field | Type | Label | Description |
    55  | ----- | ---- | ----- | ----------- |
    56  {{range .Fields -}}
    57    | {{.Name}} | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
    58  {{end}}
    59  {{end}}
    60  
    61  {{if .HasExtensions}}
    62  | Extension | Type | Base | Number | Description |
    63  | --------- | ---- | ---- |:------:| ----------- |
    64  {{range .Extensions -}}
    65    | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
    66  {{end}}
    67  {{end}}
    68  
    69  {{end}} <!-- end messages -->
    70  
    71  {{if .HasExtensions}}
    72  <a name="{{$file_name}}-extensions"></a>
    73  
    74  ### File-level Extensions
    75  | Extension | Type | Base | Number | Description |
    76  | --------- | ---- | ---- |:------:| ----------- |
    77  {{range .Extensions -}}
    78    | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
    79  {{end}}
    80  {{end}} <!-- end HasExtensions -->
    81  
    82  
    83  {{end}}