Skip to content

Commit 95e6511

Browse files
author
Frank Natividad
committed
Updating README to be explicit of the discovery document workflow
1 parent a6d6fa3 commit 95e6511

File tree

1 file changed

+21
-8
lines changed
  • appengine/endpoints-frameworks-v2/migration-example

1 file changed

+21
-8
lines changed

appengine/endpoints-frameworks-v2/migration-example/README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# Hello World Google Cloud Endpoints for App Engine
22

33
This sample provides an example of a [migration][7] from the prior version of
4-
[Google Cloud Endpoints Frameworks][3] to new [Google Cloud Endpoints Frameworks for App Engine][8].
4+
[Google Cloud Endpoints Frameworks][3] to new
5+
[Google Cloud Endpoints Frameworks for App Engine][8] using a
6+
**Discovery Document**. Additionally, this sample provides an example of using
7+
the new App Engine Maven and Gradle plugins for deploying your Google App Engine
8+
Standard applications.
9+
510
This sample contains comments of how to use the prior Endpoints Frameworks as
611
well. For clarity, the prior Endpoints Frameworks and the new Endpoints
712
Frameworks are denoted as Endpoints Frameworks v1.0 and Endpoints Frameworks
@@ -22,6 +27,10 @@ process is explained [here][8] and a quickstart is provided [here][9].
2227
- [Google Cloud Endpoints Frameworks v1.0][3]
2328

2429
## Build and Deployment Plugins
30+
- [Google App Engine Maven plugin][14]
31+
- [Google App Engine Gradle plugin][15]
32+
33+
## Discovery Document and Client Library Generation Plugins
2534
- [Google Cloud Endpoints Frameworks Maven Plugin][10]
2635
- [Google Cloud Endpoints Frameworks Gradle Plugin][11]
2736

@@ -37,10 +46,12 @@ process is explained [here][8] and a quickstart is provided [here][9].
3746
have registered in the
3847
[Credentials on Developers Console for OAuth 2.0 client IDs][6].
3948

40-
1. [Optional]: User Authenticating with Google Accounts in other Applications Types
49+
1. [Optional]: User Authenticating with Google Accounts in other Applications
50+
Types
4151

42-
- Inside [Constants.java](src/main/java/com/example/helloendpoints/Constants.java) you will find placeholders for Android
43-
applications using Google Accounts client IDs registered in the
52+
- Inside [Constants.java](src/main/java/com/example/helloendpoints/Constants.java)
53+
you will find placeholders for Android applications using Google Accounts
54+
client IDs registered in the
4455
[Credentials on Developers Console for OAuth 2.0 client IDs][6].
4556

4657
- These client IDs are used when defining annotation for this sample API
@@ -77,8 +88,8 @@ process is explained [here][8] and a quickstart is provided [here][9].
7788
7889
[http://localhost:8080/_ah/api/explorer][13]
7990
80-
1. Generate the client library located at `target/client-libs/helloworld-v1-java.zip`
81-
by using:
91+
1. Generate the client library located at
92+
`target/client-libs/helloworld-v1-java.zip` by using:
8293
8394
`mvn endpoints-framework:clientLibs`
8495
@@ -100,8 +111,8 @@ process is explained [here][8] and a quickstart is provided [here][9].
100111
101112
[http://localhost:8080/_ah/api/explorer][13]
102113
103-
1. Generate the client library located at `build/endpointsClientLibs/helloworld-v1-java.zip`
104-
by using:
114+
1. Generate the client library located at
115+
`build/endpointsClientLibs/helloworld-v1-java.zip` by using:
105116
106117
`gradle endpointsClientLibs`
107118
@@ -123,3 +134,5 @@ process is explained [here][8] and a quickstart is provided [here][9].
123134
[11]: https://github.com/GoogleCloudPlatform/endpoints-framework-gradle-plugin
124135
[12]: https://cloud.google.com/endpoints/docs/authenticating-users-frameworks
125136
[13]: http://localhost:8080/_ah/api/explorer
137+
[14]: https://github.com/GoogleCloudPlatform/app-maven-plugin
138+
[15]: https://github.com/GoogleCloudPlatform/app-gradle-plugin

0 commit comments

Comments
 (0)