Readme: Update readme templates to add api summaries. (#1299)

googleapis · May 26, 2017 · 08344b7 · 08344b7
1 parent dd3d83c
commit 08344b7
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 11 deletions.
diff --git a/src/main/java/com/google/api/codegen/transformer/PackageMetadataTransformer.java b/src/main/java/com/google/api/codegen/transformer/PackageMetadataTransformer.java
@@ -99,6 +99,7 @@ public PackageMetadataView.Builder generateMetadataView(
         .licenseName(packageConfig.licenseName())
         .fullName(model.getServiceConfig().getTitle())
         .discoveryApiName(discoveryApiName)
+        .apiSummary(model.getServiceConfig().getDocumentation().getSummary())
         .hasMultipleServices(false);
   }
 }
diff --git a/src/main/java/com/google/api/codegen/viewmodel/metadata/PackageMetadataView.java b/src/main/java/com/google/api/codegen/viewmodel/metadata/PackageMetadataView.java
@@ -51,6 +51,8 @@ public String resourceRoot() {
   @Nullable
   public abstract String identifier();
 
+  public abstract String apiSummary();
+
   public abstract VersionBound packageVersionBound();
 
   public abstract VersionBound gaxVersionBound();
@@ -173,6 +175,9 @@ public abstract static class Builder {
 
     public abstract Builder serviceName(String val);
 
+    /** The descriptive summary of the api. */
+    public abstract Builder apiSummary(String val);
+
     /** The full name of the API, including branding. E.g., "Stackdriver Logging". */
     public abstract Builder fullName(String val);
 

diff --git a/src/main/resources/com/google/api/codegen/readme.snip b/src/main/resources/com/google/api/codegen/readme.snip
@@ -7,9 +7,10 @@
 @end
 
 @private title(metadata)
-    @# {@metadata.targetLanguage} Client{@plurality(metadata.hasMultipleServices)} for {@metadata.fullName} ([{@metadata.developmentStatusTitle}]({@metadata.versioningDocumentationLink}))
+    @# {@metadata.targetLanguage} Client{@plurality(metadata.hasMultipleServices)} for \
+    {@metadata.fullName} ([{@metadata.developmentStatusTitle}]({@metadata.versioningDocumentationLink}))
 
-    Idiomatic {@metadata.targetLanguage} client{@plurality(metadata.hasMultipleServices)} for [{@metadata.fullName}][Product Documentation]
+    [{@metadata.fullName}][Product Documentation]: {@metadata.apiSummary}
   - [Client Library Documentation][]
   - [Product Documentation][]
 @end

diff --git a/src/main/resources/com/google/api/codegen/readme_rst.snip b/src/main/resources/com/google/api/codegen/readme_rst.snip
@@ -8,7 +8,7 @@
   {@metadata.targetLanguage} Client{@plurality(metadata.hasMultipleServices)} for {@metadata.fullName} (`{@metadata.developmentStatusTitle}`_)
   ==================================================================================================
 
-  Idiomatic {@metadata.targetLanguage} client for `{@metadata.fullName}`_
+  `{@metadata.fullName}`_: {@metadata.apiSummary}
 
   - `Client Library Documentation`_
   - `Product Documentation`_

diff --git a/src/test/java/com/google/api/codegen/testdata/nodejs_README_library.baseline b/src/test/java/com/google/api/codegen/testdata/nodejs_README_library.baseline
@@ -1,7 +1,7 @@
 ============== file: README.md ==============
 # Node.js Client for Google Example Library API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-node#versioning))
 
-Idiomatic Node.js client for [Google Example Library API][Product Documentation]
+[Google Example Library API][Product Documentation]: A simple Google Example Library API.
 - [Client Library Documentation][]
 - [Product Documentation][]
 

diff --git a/src/test/java/com/google/api/codegen/testdata/nodejs_README_no_path_templates.baseline b/src/test/java/com/google/api/codegen/testdata/nodejs_README_no_path_templates.baseline
@@ -1,7 +1,7 @@
 ============== file: README.md ==============
 # Node.js Client for Google Fake API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-node#versioning))
 
-Idiomatic Node.js client for [Google Fake API][Product Documentation]
+[Google Fake API][Product Documentation]: Tests no path templates
 - [Client Library Documentation][]
 - [Product Documentation][]
 

diff --git a/src/test/java/com/google/api/codegen/testdata/nodejs_doc_README_library.baseline b/src/test/java/com/google/api/codegen/testdata/nodejs_doc_README_library.baseline
@@ -1,7 +1,7 @@
 ============== file: README.md ==============
 # Node.js Client for Google Example Library API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-node#versioning))
 
-Idiomatic Node.js client for [Google Example Library API][Product Documentation]
+[Google Example Library API][Product Documentation]: A simple Google Example Library API.
 - [Client Library Documentation][]
 - [Product Documentation][]
 

diff --git a/src/test/java/com/google/api/codegen/testdata/python_README_library.baseline b/src/test/java/com/google/api/codegen/testdata/python_README_library.baseline
@@ -2,7 +2,7 @@
 Python Client for Google Example Library API (`Alpha`_)
 ==================================================================================================
 
-Idiomatic Python client for `Google Example Library API`_
+`Google Example Library API`_: A simple Google Example Library API.
 
 - `Client Library Documentation`_
 - `Product Documentation`_

diff --git a/src/test/java/com/google/api/codegen/testdata/python_README_no_path_templates.baseline b/src/test/java/com/google/api/codegen/testdata/python_README_no_path_templates.baseline
@@ -2,7 +2,7 @@
 Python Client for Google Fake API (`Beta`_)
 ==================================================================================================
 
-Idiomatic Python client for `Google Fake API`_
+`Google Fake API`_: Tests no path templates
 
 - `Client Library Documentation`_
 - `Product Documentation`_

diff --git a/src/test/java/com/google/api/codegen/testdata/python_doc_README_library.baseline b/src/test/java/com/google/api/codegen/testdata/python_doc_README_library.baseline
@@ -2,7 +2,7 @@
 Python Client for Google Example Library API (`Alpha`_)
 ==================================================================================================
 
-Idiomatic Python client for `Google Example Library API`_
+`Google Example Library API`_: A simple Google Example Library API.
 
 - `Client Library Documentation`_
 - `Product Documentation`_

diff --git a/src/test/java/com/google/api/codegen/testdata/ruby_README_library.baseline b/src/test/java/com/google/api/codegen/testdata/ruby_README_library.baseline
@@ -1,7 +1,7 @@
 ============== file: README.md ==============
 # Ruby Client for Google Example Library API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
 
-Idiomatic Ruby client for [Google Example Library API][Product Documentation]
+[Google Example Library API][Product Documentation]: A simple Google Example Library API.
 - [Client Library Documentation][]
 - [Product Documentation][]
 

diff --git a/src/test/java/com/google/api/codegen/testdata/ruby_doc_README_library.baseline b/src/test/java/com/google/api/codegen/testdata/ruby_doc_README_library.baseline
@@ -1,7 +1,7 @@
 ============== file: README.md ==============
 # Ruby Client for Google Example Library API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
 
-Idiomatic Ruby client for [Google Example Library API][Product Documentation]
+[Google Example Library API][Product Documentation]: A simple Google Example Library API.
 - [Client Library Documentation][]
 - [Product Documentation][]