Skip to content

Commit 8c81db1

Browse files
authored
Remove REST Swagger documentation (#3655)
1 parent 2f49429 commit 8c81db1

File tree

41 files changed

+7
-905
lines changed

Some content is hidden

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

41 files changed

+7
-905
lines changed

documentation/2.5/content/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,6 @@ Documentation for APIs:
8989

9090
* The operator provides a REST API that you can use to obtain configuration information and to initiate scaling actions. For details about how to use the REST APIs, see [Use the operator's REST services]({{< relref "/userguide/managing-operators/using-the-operator/the-rest-api.md#use-the-operator-s-rest-services" >}}).
9191

92-
* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
93-
9492
### Contributing to the operator
9593

9694
Oracle welcomes contributions to this project from anyone. Contributions may be reporting an issue with the operator or submitting a pull request. Before embarking on significant development that may result in a large pull request, it is recommended that you create an issue and discuss the proposed changes with the existing developers first.

documentation/2.5/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/2.5/content/userguide/managing-domains/domain-resource.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Use this document to set up and configure your own [domain resource](https://git
1212

1313
Many of the samples accompanying the operator project include scripts to generate an initial domain resource from a set of simplified inputs; however, the domain resource is the actual source of truth for how the operator will manage each WebLogic domain. You are encouraged to either start with the domain resource YAML files generated by the various samples or create domain resources manually or by using other tools based on the schema referenced here or this documentation.
1414

15-
Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
16-
1715
#### Prerequisites
1816

1917
The following prerequisites must be fulfilled before proceeding with the creation of the resource:

documentation/2.5/content/userguide/managing-operators/using-the-operator/the-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Description: "Use the operator's REST services."
77

88
#### Use the operator's REST services
99

10-
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations. Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
10+
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations.
1111

1212
You can access most of the REST services using `GET`, for example:
1313

documentation/2.6/content/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,6 @@ Documentation for APIs:
116116

117117
* The operator provides a REST API that you can use to obtain configuration information and to initiate scaling actions. For details about how to use the REST APIs, see [Use the operator's REST services]({{< relref "/userguide/managing-operators/using-the-operator/the-rest-api#use-the-operators-rest-services" >}}).
118118

119-
* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
120-
121119
### Need more help? Have a suggestion? Come and say, "Hello!"
122120

123121
We have a **public Slack channel** where you can get in touch with us to ask questions about using the operator or give us feedback

documentation/2.6/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/2.6/content/userguide/managing-domains/domain-resource.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ Use this document to set up and configure your own [domain resource](https://git
1414

1515
Many of the samples accompanying the operator project include scripts to generate an initial domain resource from a set of simplified inputs; however, the domain resource is the actual source of truth for how the operator will manage each WebLogic Server domain. You are encouraged to either start with the domain resource YAML files generated by the various samples or create domain resources manually or by using other tools based on the schema referenced here or this documentation.
1616

17-
Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
18-
1917
#### Prerequisites
2018

2119
The following prerequisites must be fulfilled before proceeding with the creation of the resource:
@@ -253,8 +251,6 @@ Use this document to set up and configure your own [domain resource](https://git
253251

254252
Many of the samples accompanying the operator project include scripts to generate an initial domain resource from a set of simplified inputs; however, the domain resource is the actual source of truth for how the operator will manage each WebLogic domain. You are encouraged to either start with the domain resource YAML files generated by the various samples or create domain resources manually or by using other tools based on the schema referenced here or this documentation.
255253

256-
Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
257-
258254
#### Prerequisites
259255

260256
The following prerequisites must be fulfilled before proceeding with the creation of the resource:

documentation/2.6/content/userguide/managing-operators/using-the-operator/the-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Description: "Use the operator's REST services."
77

88
#### Use the operator's REST services
99

10-
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations. Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
10+
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations.
1111

1212
You can access most of the REST services using `GET`, for example:
1313

documentation/3.0/content/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,6 @@ Documentation for APIs:
9191

9292
* The operator provides a REST API that you can use to obtain configuration information and to initiate scaling actions. For details about how to use the REST APIs, see [Use the operator's REST services]({{< relref "/userguide/managing-operators/using-the-operator/the-rest-api#use-the-operators-rest-services" >}}).
9393

94-
* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
95-
9694
### Need more help? Have a suggestion? Come and say, "Hello!"
9795

9896
We have a **public Slack channel** where you can get in touch with us to ask questions about using the operator or give us feedback

documentation/3.0/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/3.0/content/userguide/managing-domains/domain-resource.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,6 @@ Here are some references you can use for the fields in these sections:
102102

103103
- See [Domain spec elements](#domain-spec-elements) in this doc.
104104
- See [Domain resource](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/documentation/domains/Domain.md).
105-
- Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
106105
- Use [kubectl explain](#leveraging--kubectl-explain-) from the command line.
107106

108107
#### Using `kubectl explain`

documentation/3.0/content/userguide/managing-operators/using-the-operator/the-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Description: "Use the operator's REST services."
77

88
#### Use the operator's REST services
99

10-
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations. Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
10+
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations.
1111

1212
You can access most of the REST services using `GET`, for example:
1313

documentation/3.1/content/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,6 @@ Documentation for APIs:
8787

8888
* The operator provides a REST API that you can use to obtain configuration information and to initiate scaling actions. For details about how to use the REST APIs, see [Use the operator's REST services]({{< relref "/userguide/managing-operators/using-the-operator/the-rest-api#use-the-operators-rest-services" >}}).
8989

90-
* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
91-
9290
### Need more help? Have a suggestion? Come and say, "Hello!"
9391

9492
We have a **public Slack channel** where you can get in touch with us to ask questions about using the operator or give us feedback

documentation/3.1/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/3.1/content/userguide/managing-domains/domain-resource.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ Here are some references you can use for the fields in these sections:
103103

104104
- See [Domain spec elements](#domain-spec-elements) in this doc.
105105
- See [Domain resource](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/documentation/domains/Domain.md).
106-
- Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
107106
- Use [kubectl explain](#leveraging--kubectl-explain-) from the command line.
108107

109108
#### Using `kubectl explain`

documentation/3.1/content/userguide/managing-operators/using-the-operator/the-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Description: "Use the operator's REST services."
77

88
#### Use the operator's REST services
99

10-
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations. Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
10+
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations.
1111

1212
You can access most of the REST services using `GET`, for example:
1313

documentation/3.2/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/3.2/content/userguide/managing-domains/domain-resource.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ Here are some references you can use for the fields in these sections:
9595

9696
- See [Domain spec elements](#domain-spec-elements), [Pod Generation](#pod-generation), and [JVM memory and Java option environment variables](#jvm-memory-and-java-option-environment-variables) in this doc.
9797
- See [Domain resource](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/documentation/domains/Domain.md).
98-
- Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
9998
- Use [kubectl explain](#leveraging--kubectl-explain-) from the command line.
10099

101100
#### Using `kubectl explain`

documentation/3.2/content/userguide/managing-operators/the-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Description: "Use the operator's REST services."
77

88

99

10-
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations. Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
10+
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations.
1111

1212
You can access most of the REST services using `GET`, for example:
1313

documentation/3.3/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/3.3/content/userguide/managing-domains/domain-resource.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ Here are some references you can use for the fields in these sections:
9595

9696
- See [Domain spec elements](#domain-spec-elements), [Pod Generation](#pod-generation), and [JVM memory and Java option environment variables](#jvm-memory-and-java-option-environment-variables) in this doc.
9797
- See [Domain resource](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/documentation/domains/Domain.md).
98-
- Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
9998
- Use [kubectl explain](#leveraging--kubectl-explain-) from the command line.
10099

101100
#### Using `kubectl explain`

documentation/3.3/content/userguide/managing-operators/the-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Description: "Use the operator's REST services."
77

88

99

10-
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations. Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
10+
The operator provides a REST server which you can use to get a list of WebLogic domains and clusters and to initiate scaling operations.
1111

1212
You can access most of the REST services using `GET`, for example:
1313

documentation/3.4/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/3.4/content/userguide/managing-domains/domain-resource.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ Here are some references you can use for the fields in these sections:
7878

7979
- See [Domain spec elements](#domain-spec-elements), [Pod Generation](#pod-generation), and [JVM memory and Java option environment variables](#jvm-memory-and-java-option-environment-variables) in this doc.
8080
- See [Domain resource](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md).
81-
- Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
8281
- Use [kubectl explain](#using-kubectl-explain) from the command line.
8382

8483
#### Using `kubectl explain`

documentation/3.4/content/userguide/managing-operators/the-rest-api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ You can use the API as an alternative method for getting a list of WebLogic doma
2323
or for getting certain aspects of a domain's status (for example, instead of calling `kubectl get domain MYDOMAIN -o yaml`).
2424
You also can use the REST API as an alternative approach for initiating scaling operations
2525
(instead of using the Kubernetes API or command line to alter a domain resource's `replicas` values).
26-
Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
2726

2827
#### Configure the operator's external REST HTTPS interface
2928

documentation/4.0/content/managing-operators/the-rest-api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ You can use the API as an alternative method for getting a list of WebLogic doma
1414
or for getting certain aspects of a domain's status (for example, instead of calling `kubectl get domain MYDOMAIN -o yaml`).
1515
You also can use the REST API as an alternative approach for initiating scaling operations
1616
(instead of using the Kubernetes API or command line to alter a domain resource's `replicas` values).
17-
Swagger documentation for the REST API is available [here](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html).
1817

1918
### Configure the operator's external REST HTTPS interface
2019

documentation/4.0/content/reference/swagger.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

documentation/publish.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ hugo -s 3.3 -d "${outdir}/3.3" -b https://oracle.github.io/weblogic-kubernetes-o
5050
hugo -s 3.4 -d "${outdir}/3.4" -b https://oracle.github.io/weblogic-kubernetes-operator/3.4
5151

5252
echo "Copying static files into place..."
53-
cp -R charts domains swagger "${outdir}"
53+
cp -R charts domains "${outdir}"
5454

5555
echo "Successfully generated documentation in ${outdir}..."
5656

-445 Bytes
Binary file not shown.
-1.11 KB
Binary file not shown.

0 commit comments

Comments
 (0)