-
Notifications
You must be signed in to change notification settings - Fork 118
Generate API docs #1884
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.
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
Merged
Merged
Generate API docs #1884
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
35fdcfa
Generate API docs
lucacome 623c069
Fix Style
lucacome 2216a10
more fixes
lucacome d3ae109
client settings policy
lucacome b25da33
Further reading
lucacome b79d175
Apply suggestions from code review
lucacome 1c28546
Bump k8s version and remove unused config section
lucacome File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| { | ||
| "hideMemberFields": [ | ||
| "TypeMeta" | ||
| ], | ||
| "hideTypePatterns": [ | ||
| "ParseError$", | ||
| "List$" | ||
| ], | ||
| "externalPackages": [ | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", | ||
| "docsURLTemplate": "https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", | ||
| "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/", | ||
lucacome marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "docsURLTemplate": "https://pkg.go.dev/github.com/knative/pkg/apis/duck/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^sigs.k8s.io/gateway-api/apis/", | ||
| "docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/gateway-api/apis/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}" | ||
| } | ||
| ], | ||
| "typeDisplayNamePrefixOverrides": { | ||
| "k8s.io/api/": "Kubernetes ", | ||
| "k8s.io/apimachinery/pkg/apis/": "Kubernetes " | ||
| }, | ||
| "markdownDisabled": false | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| {{ define "members" }} | ||
|
|
||
| {{ range .Members }} | ||
| {{ if not (hiddenMember .)}} | ||
| <tr> | ||
| <td> | ||
| <code>{{ fieldName . }}</code><br/> | ||
| <em> | ||
| {{ if linkForType .Type }} | ||
| <a href="{{ linkForType .Type}}"> | ||
| {{ typeDisplayName .Type }} | ||
| </a> | ||
| {{ else }} | ||
| {{ typeDisplayName .Type }} | ||
| {{ end }} | ||
| </em> | ||
| </td> | ||
| <td> | ||
| {{ if fieldEmbedded . }} | ||
| <p> | ||
| (Members of <code>{{ fieldName . }}</code> are embedded into this type.) | ||
| </p> | ||
| {{ end}} | ||
|
|
||
| {{ if isOptionalMember .}} | ||
| <em>(Optional)</em> | ||
| {{ end }} | ||
|
|
||
| {{ safe (renderComments .CommentLines) }} | ||
|
|
||
| {{ if and (eq (.Type.Name.Name) "ObjectMeta") }} | ||
| Refer to the Kubernetes API documentation for the fields of the | ||
| <code>metadata</code> field. | ||
| {{ end }} | ||
|
|
||
| {{ if or (eq (fieldName .) "spec") }} | ||
| <br/> | ||
| <br/> | ||
| <table class="table table-bordered table-striped"> | ||
| {{ template "members" .Type }} | ||
| </table> | ||
| {{ end }} | ||
| </td> | ||
| </tr> | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| {{ end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| {{ define "packages" }} | ||
| --- | ||
| title: "API Reference" | ||
| description: "NGINX Gateway API Reference" | ||
| weight: 100 | ||
| toc: false | ||
| --- | ||
|
|
||
| {{ with .packages}} | ||
| <p>Packages:</p> | ||
| <ul> | ||
| {{ range . }} | ||
| <li> | ||
| <a href="#{{- packageAnchorID . -}}">{{ packageDisplayName . }}</a> | ||
| </li> | ||
| {{ end }} | ||
| </ul> | ||
| {{ end}} | ||
|
|
||
| {{ range .packages }} | ||
| <h2 id="{{- packageAnchorID . -}}"> | ||
| {{- packageDisplayName . -}} | ||
| </h2> | ||
|
|
||
| {{ with (index .GoPackages 0 )}} | ||
| {{ with .DocComments }} | ||
| <p> | ||
| {{ safe (renderComments .) }} | ||
| </p> | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| Resource Types: | ||
| <ul> | ||
| {{- range (visibleTypes (sortedTypes .Types)) -}} | ||
| {{ if isExportedType . -}} | ||
| <li> | ||
| <a href="{{ linkForType . }}">{{ typeDisplayName . }}</a> | ||
| </li> | ||
| {{- end }} | ||
| {{- end -}} | ||
| </ul> | ||
|
|
||
| {{ range (visibleTypes (sortedTypes .Types))}} | ||
| {{ template "type" . }} | ||
| {{ end }} | ||
| <hr/> | ||
| {{ end }} | ||
|
|
||
| <p><em> | ||
| Generated with <code>gen-crd-api-reference-docs</code> | ||
| </em></p> | ||
|
|
||
| {{ end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| {{ define "type" }} | ||
|
|
||
| <h3 id="{{ anchorIDForType . }}"> | ||
| {{- .Name.Name }} | ||
| {{ if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias)</p>{{ end -}} | ||
| <a class="headerlink" href="#{{ anchorIDForType . }}" title="Permanent link">¶</a> | ||
| </h3> | ||
| {{ with (typeReferences .) }} | ||
| <p> | ||
| (<em>Appears on: </em> | ||
| {{- $prev := "" -}} | ||
| {{- range . -}} | ||
| {{- if $prev -}},{{ end -}} | ||
| {{ $prev = . }} | ||
| <a href="{{ linkForType . }}">{{ typeDisplayName . }}</a> | ||
| {{- end -}} | ||
| ) | ||
| </p> | ||
| {{ end }} | ||
|
|
||
|
|
||
| <p> | ||
| {{ safe (renderComments .CommentLines) }} | ||
| </p> | ||
|
|
||
| {{ with (constantsOfType .) }} | ||
| <table class="table table-bordered table-striped"> | ||
| <thead> | ||
| <tr> | ||
| <th>Value</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {{- range . -}} | ||
| <tr> | ||
| {{- /* | ||
| renderComments implicitly creates a <p> element, so we | ||
| add one to the display name as well to make the contents | ||
| of the two cells align evenly. | ||
| */ -}} | ||
| <td><p>{{ typeDisplayName . }}</p></td> | ||
| <td>{{ safe (renderComments .CommentLines) }}</td> | ||
| </tr> | ||
| {{- end -}} | ||
| </tbody> | ||
| </table> | ||
| {{ end }} | ||
|
|
||
| {{ if .Members }} | ||
| <table class="table table-bordered table-striped"> | ||
| <thead> | ||
| <tr> | ||
| <th>Field</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {{ if isExportedType . }} | ||
| <tr> | ||
| <td> | ||
| <code>apiVersion</code><br/> | ||
| string</td> | ||
| <td> | ||
| <code> | ||
| {{apiGroup .}} | ||
| </code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <code>kind</code><br/> | ||
| string | ||
| </td> | ||
| <td><code>{{.Name.Name}}</code></td> | ||
| </tr> | ||
| {{ end }} | ||
| {{ template "members" .}} | ||
| </tbody> | ||
| </table> | ||
| {{ end }} | ||
|
|
||
| {{ end }} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.