-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add openapi-appengine.yaml file for App Engine deployments. (#769)
* Create openapi-appengine.yaml * Change copyright date to 2017. * Add comment to openapi.yaml about deploying on App Engine. Remove openapi-appengine.yaml. * Add openapi-appengine.yaml file for App Engine deployments. * Fix date.
- Loading branch information
Showing
2 changed files
with
122 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
# Copyright 2017 Google Inc. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# [START swagger] | ||
swagger: "2.0" | ||
info: | ||
description: "A simple Google Cloud Endpoints API example." | ||
title: "Endpoints Example" | ||
version: "1.0.0" | ||
host: "YOUR-PROJECT-ID.appspot.com" | ||
# [END swagger] | ||
basePath: "/" | ||
consumes: | ||
- "application/json" | ||
produces: | ||
- "application/json" | ||
schemes: | ||
- "https" | ||
paths: | ||
"/echo": | ||
post: | ||
description: "Echo back a given message." | ||
operationId: "echo" | ||
produces: | ||
- "application/json" | ||
responses: | ||
200: | ||
description: "Echo" | ||
schema: | ||
$ref: "#/definitions/echoMessage" | ||
parameters: | ||
- | ||
description: "Message to echo" | ||
in: body | ||
name: message | ||
required: true | ||
schema: | ||
$ref: "#/definitions/echoMessage" | ||
security: | ||
- api_key: [] | ||
"/auth/info/googlejwt": | ||
get: | ||
description: "Returns the requests' authentication information." | ||
operationId: "auth_info_google_jwt" | ||
produces: | ||
- "application/json" | ||
responses: | ||
200: | ||
description: "Authenication info." | ||
schema: | ||
$ref: "#/definitions/authInfoResponse" | ||
security: | ||
- api_key: [] | ||
google_jwt: [] | ||
"/auth/info/googleidtoken": | ||
get: | ||
description: "Returns the requests' authentication information." | ||
operationId: "authInfoGoogleIdToken" | ||
produces: | ||
- "application/json" | ||
responses: | ||
200: | ||
description: "Authenication info." | ||
schema: | ||
$ref: "#/definitions/authInfoResponse" | ||
security: | ||
- api_key: [] | ||
google_id_token: [] | ||
definitions: | ||
echoMessage: | ||
properties: | ||
message: | ||
type: "string" | ||
authInfoResponse: | ||
properties: | ||
id: | ||
type: "string" | ||
email: | ||
type: "string" | ||
securityDefinitions: | ||
# This section configures basic authentication with an API key. | ||
api_key: | ||
type: "apiKey" | ||
name: "key" | ||
in: "query" | ||
# This section configures authentication using Google API Service Accounts | ||
# to sign a json web token. This is mostly used for server-to-server | ||
# communication. | ||
google_jwt: | ||
authorizationUrl: "" | ||
flow: "implicit" | ||
type: "oauth2" | ||
# This must match the 'iss' field in the JWT. | ||
x-google-issuer: "jwt-client.endpoints.sample.google.com" | ||
# Update this with your service account's email address. | ||
x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR-SERVICE-ACCOUNT-EMAIL" | ||
# This must match the "aud" field in the JWT. You can add multiple | ||
# audiences to accept JWTs from multiple clients. | ||
x-google-audiences: "echo.endpoints.sample.google.com" | ||
# This section configures authentication using Google OAuth2 ID Tokens. | ||
# ID Tokens can be obtained using OAuth2 clients, and can be used to access | ||
# your API on behalf of a particular user. | ||
google_id_token: | ||
authorizationUrl: "" | ||
flow: "implicit" | ||
type: "oauth2" | ||
x-google-issuer: "https://accounts.google.com" | ||
x-google-jwks_uri: "https://www.googleapis.com/oauth2/v3/certs" | ||
# Your OAuth2 client's Client ID must be added here. You can add | ||
# multiple client IDs to accept tokens from multiple clients. | ||
x-google-audiences: "YOUR-CLIENT-ID" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters