Skip to content

Commit 6878183

Browse files
jasminejaksicJon Wayne Parrott
jasminejaksic
authored and
Jon Wayne Parrott
committed
Replaced swagger.yaml with openapi.yaml (GoogleCloudPlatform#682)
1 parent 4fd06e1 commit 6878183

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

‎appengine/flexible/endpoints/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The `APIKEY` doesn't matter as the endpoint proxy is not running to do authentic
3636

3737
## Deploying to Google App Engine
3838

39-
Open the `swagger.yaml` file and in the `host` property, replace
39+
Open the `openapi.yaml` file and in the `host` property, replace
4040
`YOUR-PROJECT-ID` with your project's ID.
4141

4242
Then, deploy the sample using `gcloud`:
@@ -72,7 +72,7 @@ The JWT client demonstrates how to use a service account to authenticate to endp
7272

7373
To use the service account for authentication:
7474

75-
1. Update the `google_jwt`'s `x-jwks_uri` in `swagger.yaml` with your service account's email address.
75+
1. Update the `google_jwt`'s `x-jwks_uri` in `openapi.yaml` with your service account's email address.
7676
2. Redeploy your application.
7777

7878
Now you can use the JWT client to make requests to the API:
@@ -91,7 +91,7 @@ The ID Token client demonstrates how to use user credentials to authenticate to
9191

9292
To use the client ID for authentication:
9393

94-
1. Update the `/auth/info/googleidtoken`'s `audiences` in `swagger.yaml` with your client ID.
94+
1. Update the `/auth/info/googleidtoken`'s `audiences` in `openapi.yaml` with your client ID.
9595
2. Redeploy your application.
9696

9797
Now you can use the client ID to make requests to the API:
@@ -106,7 +106,7 @@ We refer to the project that serves API requests as the server project. You also
106106

107107
To use the App Engine default service account for authentication:
108108

109-
1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your client project ID.
109+
1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your client project ID.
110110
2. Redeploy your server application.
111111
3. Update clients/service_to_service_gae_default/main.py, replace 'YOUR-CLIENT-PROJECT-ID' and 'YOUR-SERVER-PROJECT-ID' with your client project ID and your server project ID.
112112
4. Upload your application to Google App Engine by invoking the following command. Note that you need to provide project ID in the command because there are two projects (server and client projects) here and gcloud needs to know which project to pick.
@@ -137,7 +137,7 @@ Google API python client library should have already been installed under 'lib'
137137

138138
To use the client for authentication:
139139

140-
1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your service account email.
140+
1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your service account email.
141141
2. Redeploy your server application.
142142
3. Update clients/service_to_service_non_default/main.py by replacing 'YOUR-SERVICE-ACCOUNT-EMAIL', 'YOUR-SERVER-PROJECT-ID' and 'YOUR-CLIENT-PROJECT-ID'
143143
with your service account email, your server project ID, and your client project ID, respectively.

‎appengine/flexible/endpoints/app.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ runtime_config:
88
beta_settings:
99
# Enable Google Cloud Endpoints API management.
1010
use_endpoints_api_management: true
11-
# Specify the Swagger API specification.
12-
endpoints_swagger_spec_file: swagger.yaml
11+
# Specify the Open API specification.
12+
endpoints_swagger_spec_file: openapi.yaml

appengine/flexible/endpoints/swagger.yaml renamed to appengine/flexible/endpoints/openapi.yaml

File renamed without changes.

‎endpoints/getting-started/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The JWT client demonstrates how to use a service account to authenticate to endp
6767

6868
To use the service account for authentication:
6969

70-
1. Update the `google_jwt`'s `x-jwks_uri` in `swagger.yaml` with your service account's email address.
70+
1. Update the `google_jwt`'s `x-jwks_uri` in `openapi.yaml` with your service account's email address.
7171
2. Redeploy your application.
7272

7373
Now you can use the JWT client to make requests to the API:
@@ -86,7 +86,7 @@ The ID Token client demonstrates how to use user credentials to authenticate to
8686

8787
To use the client ID for authentication:
8888

89-
1. Update the `/auth/info/googleidtoken`'s `audiences` in `swagger.yaml` with your client ID.
89+
1. Update the `/auth/info/googleidtoken`'s `audiences` in `openapi.yaml` with your client ID.
9090
2. Redeploy your application.
9191

9292
Now you can use the client ID to make requests to the API:
@@ -101,7 +101,7 @@ We refer to the project that serves API requests as the server project. You also
101101

102102
To use the App Engine default service account for authentication:
103103

104-
1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your client project ID.
104+
1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your client project ID.
105105
2. Redeploy your server application.
106106
3. Update clients/service_to_service_gae_default/main.py, replace 'YOUR-CLIENT-PROJECT-ID' and 'YOUR-SERVER-PROJECT-ID' with your client project ID and your server project ID.
107107
4. Upload your application to Google App Engine by invoking the following command. Note that you need to provide project ID in the command because there are two projects (server and client projects) here and gcloud needs to know which project to pick.
@@ -132,7 +132,7 @@ Google API python client library should have already been installed under 'lib'
132132

133133
To use the client for authentication:
134134

135-
1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your service account email.
135+
1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your service account email.
136136
2. Redeploy your server application.
137137
3. Update clients/service_to_service_non_default/main.py by replacing 'YOUR-SERVICE-ACCOUNT-EMAIL', 'YOUR-SERVER-PROJECT-ID' and 'YOUR-CLIENT-PROJECT-ID'
138138
with your service account email, your server project ID, and your client project ID, respectively.

‎endpoints/getting-started/app.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ runtime_config:
88
beta_settings:
99
# Enable Google Cloud Endpoints API management.
1010
use_endpoints_api_management: true
11-
# Specify the Swagger API specification.
12-
endpoints_swagger_spec_file: swagger.yaml
11+
# Specify the Open API specification.
12+
endpoints_swagger_spec_file: openapi.yaml

endpoints/getting-started/swagger.yaml renamed to endpoints/getting-started/openapi.yaml

File renamed without changes.

0 commit comments

Comments
 (0)