Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
K
k3s
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jacklull
k3s
Commits
c7ae61b3
Commit
c7ae61b3
authored
Jun 05, 2017
by
mbohlool
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add OpenAPI README file
parent
c13d8917
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
61 additions
and
0 deletions
+61
-0
README.md
api/openapi-spec/README.md
+60
-0
verify-openapi-spec.sh
hack/verify-openapi-spec.sh
+1
-0
No files found.
api/openapi-spec/README.md
0 → 100644
View file @
c7ae61b3
# Kubernetes's OpenAPI Specification
This folder contains an
[
OpenAPI specification
][
openapi
]
for Kubernetes API.
## Vendor Extensions
Kuberntes extends OpenAPI using these extensions. Note the version that
extensions has been added.
### `x-kubernetes-group-version-kind`
Operations and Definitions may have
`x-kubernetes-group-version-kind`
if they
are associated with a
[
kubernetes resource
](
https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#resources
)
.
For example:
```
json
"paths"
:
{
...
"/api/v1/namespaces/{namespace}/pods/{name}"
:
{
...
"get"
:
{
...
"x-kubernetes-group-version-kind"
:
{
"group"
:
""
,
"version"
:
"v1"
,
"kind"
:
"Pod"
}
}
}
}
```
### `x-kubernetes-action`
Operations and Definitions may have
`x-kubernetes-action`
if they
are associated with a
[
kubernetes resource
](
https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#resources
)
.
Action can be one of
`get`
,
`list`
,
`put`
,
`patch`
,
`post`
,
`delete`
,
`deletecollection`
,
`watch`
,
`watchlist`
,
`proxy`
, or
`connect`
.
For example:
```
json
"paths"
:
{
...
"/api/v1/namespaces/{namespace}/pods/{name}"
:
{
...
"get"
:
{
...
"x-kubernetes-action"
:
"list"
}
}
}
```
### `x-kubernetes-patch-strategy` and `x-kubernetes-patch-merge-key`
Some of the definitions may have these extensions. For more information about PatchStrategy and PatchMergeKey see
[
strategic-merge-patch
]
(
https://github.com/kubernetes/community/blob/3a1e6d22f812751ee88eccf7c59101852de63d5b/contributors/devel/strategic-merge-patch.md
)
.
hack/verify-openapi-spec.sh
View file @
c7ae61b3
...
@@ -36,6 +36,7 @@ cp -a "${SPECROOT}" "${TMP_SPECROOT}"
...
@@ -36,6 +36,7 @@ cp -a "${SPECROOT}" "${TMP_SPECROOT}"
trap
"cp -a
${
TMP_SPECROOT
}
${
SPECROOT
}
/..; rm -rf
${
_tmp
}
"
EXIT SIGINT
trap
"cp -a
${
TMP_SPECROOT
}
${
SPECROOT
}
/..; rm -rf
${
_tmp
}
"
EXIT SIGINT
rm
${
SPECROOT
}
/
*
rm
${
SPECROOT
}
/
*
cp
${
TMP_SPECROOT
}
/BUILD
${
SPECROOT
}
/BUILD
cp
${
TMP_SPECROOT
}
/BUILD
${
SPECROOT
}
/BUILD
cp
${
TMP_SPECROOT
}
/README.md
${
SPECROOT
}
/README.md
"
${
KUBE_ROOT
}
/hack/update-openapi-spec.sh"
"
${
KUBE_ROOT
}
/hack/update-openapi-spec.sh"
echo
"diffing
${
SPECROOT
}
against freshly generated openapi spec"
echo
"diffing
${
SPECROOT
}
against freshly generated openapi spec"
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment