Skip to content

Replaced 'swagger.yaml' with openapi.yaml. Refer to b/32670418. #682

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.

Sign up for GitHub

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
theacodes merged 2 commits into from
Nov 28, 2016
Merged

Replaced 'swagger.yaml' with openapi.yaml. Refer to b/32670418. #682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0307c0
Replaced 'swagger.yaml' with openapi.yaml. Refer to b/32670418.
jasminejaksic-zz Nov 26, 2016
f63db96
Updating Swagger API references
jasminejaksic-zz Nov 28, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions appengine/flexible/endpoints/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The `APIKEY` doesn't matter as the endpoint proxy is not running to do authentic

## Deploying to Google App Engine

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

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

To use the service account for authentication:

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

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

To use the client ID for authentication:

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

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

To use the App Engine default service account for authentication:

1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your client project ID.
1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your client project ID.
2. Redeploy your server application.
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.
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.
Expand Down Expand Up @@ -137,7 +137,7 @@ Google API python client library should have already been installed under 'lib'

To use the client for authentication:

1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your service account email.
1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your service account email.
2. Redeploy your server application.
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'
with your service account email, your server project ID, and your client project ID, respectively.
Expand Down
4 changes: 2 additions & 2 deletions appengine/flexible/endpoints/app.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ runtime_config:
beta_settings:
# Enable Google Cloud Endpoints API management.
use_endpoints_api_management: true
# Specify the Swagger API specification.
endpoints_swagger_spec_file: swagger.yaml
# Specify the Open API specification.
endpoints_swagger_spec_file: openapi.yaml
0 appengine/flexible/endpoints/swagger.yaml → appengine/flexible/endpoints/openapi.yaml
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions endpoints/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The JWT client demonstrates how to use a service account to authenticate to endp

To use the service account for authentication:

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

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

To use the client ID for authentication:

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

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

To use the App Engine default service account for authentication:

1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your client project ID.
1. Update the `gae_default_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your client project ID.
2. Redeploy your server application.
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.
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.
Expand Down Expand Up @@ -132,7 +132,7 @@ Google API python client library should have already been installed under 'lib'

To use the client for authentication:

1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `swagger.yaml` with your service account email.
1. Update the `google_service_account`'s `x-issuer` and `x-jwks_uri` in `openapi.yaml` with your service account email.
2. Redeploy your server application.
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'
with your service account email, your server project ID, and your client project ID, respectively.
Expand Down
4 changes: 2 additions & 2 deletions endpoints/getting-started/app.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ runtime_config:
beta_settings:
# Enable Google Cloud Endpoints API management.
use_endpoints_api_management: true
# Specify the Swagger API specification.
endpoints_swagger_spec_file: swagger.yaml
# Specify the Open API specification.
endpoints_swagger_spec_file: openapi.yaml
0 endpoints/getting-started/swagger.yaml → endpoints/getting-started/openapi.yaml
View file
Open in desktop
File renamed without changes.