Updates the Endpoints getting-started sample. (#642)

Adds the same updates in the comments in #627. Also fixes the variables to replace in app.yaml.
GoogleCloudPlatform · May 3, 2017 · 2d71e88 · 2d71e88
1 parent dfb4142
commit 2d71e88
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 35 deletions.
diff --git a/endpoints/getting-started/openapi.yaml b/endpoints/getting-started/openapi.yaml
@@ -1,3 +1,17 @@
+# Copyright 2015 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:
@@ -8,60 +22,61 @@ host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
 # [END swagger]
 basePath: "/"
 consumes:
-- "application/json"
+  - "application/json"
 produces:
-- "application/json"
+  - "application/json"
 schemes:
-- "https"
+  - "https"
 paths:
   "/echo":
     post:
       description: "Echo back a given message."
       operationId: "echo"
       produces:
-      - "application/json"
+        - "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"
+        -
+          description: "Message to echo"
+          in: body
+          name: message
+          required: true
+          schema:
+            $ref: "#/definitions/echoMessage"
       security:
-      - api_key: []
+        - api_key: []
   "/auth/info/googlejwt":
     get:
       description: "Returns the requests' authentication information."
       operationId: "auth_info_google_jwt"
       produces:
-      - "application/json"
+        - "application/json"
       responses:
         200:
           description: "Authenication info."
           schema:
             $ref: "#/definitions/authInfoResponse"
       security:
-      - api_key: []
-      - google_jwt: []
+        - api_key: []
+        - google_jwt: []
   "/auth/info/googleidtoken":
     get:
       description: "Returns the requests' authentication information."
       operationId: "authInfoGoogleIdToken"
       produces:
-      - "application/json"
+        - "application/json"
       responses:
         200:
           description: "Authenication info."
           schema:
             $ref: "#/definitions/authInfoResponse"
       security:
-      - api_key: []
-      - google_id_token: []
+        - api_key: []
+        - google_id_token: []
 definitions:
   echoMessage:
     properties:

diff --git a/endpoints/getting-started/pom.xml b/endpoints/getting-started/pom.xml
@@ -1,4 +1,18 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2016 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.
+-->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
@@ -48,26 +62,13 @@
     <!-- for hot reload of the web application -->
     <outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory>
     <plugins>
-      <plugin>  <!-- TEMPORARY -->
-        <groupId>com.google.appengine</groupId>
-        <artifactId>gcloud-maven-plugin</artifactId>
-        <version>2.0.9.121.v20160815</version>
-      </plugin>
       <plugin>
         <groupId>com.google.cloud.tools</groupId>
         <artifactId>appengine-maven-plugin</artifactId>
         <version>${appengine.maven.plugin}</version>
         <configuration>
         </configuration>
       </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-war-plugin</artifactId>
-        <version>${maven.war.plugin}</version>
-        <configuration>
-          <failOnMissingWebXml>false</failOnMissingWebXml>
-        </configuration>
-      </plugin>
       <plugin>
         <groupId>org.eclipse.jetty</groupId>
         <artifactId>jetty-maven-plugin</artifactId>

diff --git a/endpoints/getting-started/src/main/appengine/app.yaml b/endpoints/getting-started/src/main/appengine/app.yaml
@@ -1,3 +1,17 @@
+# Copyright 2015 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.
+
 runtime: custom
 env: flex
 
@@ -9,5 +23,5 @@ handlers:
 endpoints_api_service:
   # The following values are to be replaced by information from the output of
   # 'gcloud service-management deploy openapi.yaml' command.
-  name: ENDPOINTS SERVICE-NAME
-  config_id: ENDPOINTS CONFIG-ID
+  name: ENDPOINTS-SERVICE-NAME
+  config_id: ENDPOINTS-CONFIG-ID
diff --git a/endpoints/getting-started/src/main/docker/Dockerfile b/endpoints/getting-started/src/main/docker/Dockerfile
@@ -1,3 +1,17 @@
+# Copyright 2015 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.
+
 FROM gcr.io/google_appengine/jetty9
 
 ADD endpoints-1.0-SNAPSHOT.war $JETTY_BASE/webapps/root.war

diff --git a/endpoints/multiple-versions/src/main/appengine/app.yaml b/endpoints/multiple-versions/src/main/appengine/app.yaml
@@ -23,5 +23,5 @@ handlers:
 endpoints_api_service:
   # The following values are to be replaced by information from the output of
   # 'gcloud service-management deploy openapi-v1.yaml openapi-v2.yaml' command.
-  name: ENDPOINTS SERVICE-NAME
-  config_id: ENDPOINTS CONFIG-ID
+  name: ENDPOINTS-SERVICE-NAME
+  config_id: ENDPOINTS-CONFIG-ID