Skip to content

Commit 2b259f7

Browse files
author
OpenShift Bot
authored
Merge pull request #10983 from smarterclayton/openapi
Merged by openshift-bot
2 parents ed1c018 + 3991f76 commit 2b259f7

File tree

92 files changed

+64525
-722
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+64525
-722
lines changed

api/README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
OpenShift API Documentation
22
---------------------------
33

4-
This directory contains a Swagger API definition for the OpenShift and Kubernetes APIs. The `swagger-spec` directory is generated automatically, and the other directories contain content that is used to generate the official documentation.
4+
This directory contains a Swagger 1.0 and OpenAPI (Swagger 2.0) API definition for the OpenShift and Kubernetes APIs.
5+
The `swagger-spec` and `protobuf-spec` directories are generated automatically.
6+
7+
* [Swagger 1.0 - OpenShift](./swagger-spec/oapi-v1.json)
8+
* [Swagger 1.0 - Kubernetes](./swagger-spec/api-v1.json)
9+
* [OpenAPI / Swagger 2.0 - OpenShift and Kubernetes](./swagger-spec/openshift-openapi-spec.json)
10+
* [Protobuf .proto files for all APIs](./protobuf-spec/)
511

612
When you add a new object or field to the REST API, you should do the following:
713

8-
* Ensure all of your fields have the description tag
9-
* Run `hack/update-swagger-spec.sh`
10-
* If you've added a new object, add a simple description to `api/definitions/v1.objectname/description.adoc` (object name is all lower case for your Kind)
11-
* For an example, see `api/definitions/v1.persistentvolumeclaim/description.adoc`
14+
* Ensure all of your fields and objects have the description tag
15+
* Run `hack/update-generated-swagger-spec.sh`
1216

1317
To generate the docs, you need gradle 2.2+ installed, then run
1418

15-
$ hack/update-swagger-docs.sh
19+
$ hack/update-generated-swagger-docs.sh
1620

1721
That will create docs into _output/local/docs/swagger/api/v1 and oapi/v1 for the Kube and OpenShift docs.
1822

api/definitions/v1.buildconfig/description.adoc

-3
This file was deleted.

api/definitions/v1.cindervolumesource/description.adoc

-1
This file was deleted.

api/definitions/v1.deploymentconfig/description.adoc

-3
This file was deleted.

api/definitions/v1.deploymentlog/description.adoc

-1
This file was deleted.

api/definitions/v1.downwardapivolumefile/description.adoc

-1
This file was deleted.

api/definitions/v1.downwardapivolumesource/description.adoc

-1
This file was deleted.

api/definitions/v1.fsgroupstrategyoptions/description.adoc

-1
This file was deleted.

api/definitions/v1.idrange/description.adoc

-1
This file was deleted.

api/definitions/v1.imagesource/description.adoc

-8
This file was deleted.

api/definitions/v1.imagesourcepath/description.adoc

-3
This file was deleted.

api/definitions/v1.imagestreamimport/description.adoc

-4
This file was deleted.

api/definitions/v1.localresourceaccessreview/description.adoc

-1
This file was deleted.

api/definitions/v1.localsubjectaccessreview/description.adoc

-1
This file was deleted.

api/definitions/v1.netnamespace/description.adoc

-1
This file was deleted.

api/definitions/v1.netnamespacelist/description.adoc

-1
This file was deleted.

api/definitions/v1.node/description.adoc

-1
This file was deleted.

api/definitions/v1.persistentvolume/description.adoc

-3
This file was deleted.

api/definitions/v1.persistentvolumeclaim/description.adoc

-1
This file was deleted.

api/definitions/v1.pod/description.adoc

-3
This file was deleted.

api/definitions/v1.project/description.adoc

-1
This file was deleted.

api/definitions/v1.route/description.adoc

-1
This file was deleted.

api/definitions/v1.secretbuildsource/description.adoc

-1
This file was deleted.

api/definitions/v1.secretspec/description.adoc

-1
This file was deleted.

api/definitions/v1.service/description.adoc

-7
This file was deleted.

api/definitions/v1.supplementalgroupsstrategyoptions/description.adoc

-1
This file was deleted.

api/definitions/v1.user/description.adoc

-1
This file was deleted.

api/definitions/v1beta1.scale/description.adoc

-7
This file was deleted.

api/paths/list_or_watch_objects_of_kind_persistentvolumeclaim/description.adoc

-1
This file was deleted.

0 commit comments

Comments
 (0)