From 8c3d925df5b1112b5467755847d579685b1ac005 Mon Sep 17 00:00:00 2001 From: Jonas Wanke Date: Thu, 5 Sep 2019 17:09:28 +0200 Subject: [PATCH 1/6] docs: add missing changelog entry for v0.0.7 --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 24c85e2..b51c711 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### BREAKING CHANGES - **course, food, news:** support pagination +### Added +- **crashreporting:** add Crash Reporting definitions + ### Removed - **food:** remove MenuItem.substitution From e5b0c24495f177d79a1157c95702693766ee880a Mon Sep 17 00:00:00 2001 From: Jonas Wanke Date: Mon, 30 Sep 2019 18:46:40 +0200 Subject: [PATCH 2/6] feat(course): support multiple lecturers --- hpi/cloud/course/v1test/course.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hpi/cloud/course/v1test/course.proto b/hpi/cloud/course/v1test/course.proto index 7f5116b..8fe8a9d 100644 --- a/hpi/cloud/course/v1test/course.proto +++ b/hpi/cloud/course/v1test/course.proto @@ -73,8 +73,8 @@ message Course { // Required. The ID of the semester that this course takes place in. string semester_id = 3; - // Required. The lecturer. - string lecturer = 4; + // Required. The lecturers. + repeated string lecturers = 4; // The assistants. repeated string assistants = 5; From fa1e2ae423c8fe2f2810626b7d2abe7b144d486d Mon Sep 17 00:00:00 2001 From: Jonas Wanke Date: Mon, 30 Sep 2019 18:48:40 +0200 Subject: [PATCH 3/6] chore: update gitignore --- .gitignore | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 013695d..f425376 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ # Generated files -src/ -lib/proto/ +gen/ # Gradle .gradle From 220f9b4a7b9634aa4c3ecabe3795b9c25cebc1c4 Mon Sep 17 00:00:00 2001 From: Jonas Wanke Date: Tue, 1 Oct 2019 11:33:28 +0200 Subject: [PATCH 4/6] feat(myhpi): restructure MyHPI --- hpi/cloud/myhpi/v1test/info_bit.proto | 66 ++++++++++++++++------ hpi/cloud/myhpi/v1test/myhpi_service.proto | 65 ++++++++++++++++++++- 2 files changed, 113 insertions(+), 18 deletions(-) diff --git a/hpi/cloud/myhpi/v1test/info_bit.proto b/hpi/cloud/myhpi/v1test/info_bit.proto index 885e140..1c7d666 100644 --- a/hpi/cloud/myhpi/v1test/info_bit.proto +++ b/hpi/cloud/myhpi/v1test/info_bit.proto @@ -2,6 +2,8 @@ syntax = "proto3"; package hpi.cloud.myhpi.v1test; +import "hpi/cloud/common/v1test/image.proto"; + option java_multiple_files = true; option java_outer_classname = "InfoBitProto"; option java_package = "de.hpi.cloud.myhpi.v1test"; @@ -11,16 +13,48 @@ message InfoBit { // Required, output only. The unique ID of this info bit. string id = 1; + // ID of the parent info bit. + string parent_id = 2; + // Required. The title. - string title = 2; + string title = 3; + + // The subtitle. + string subtitle = 4; + + // The cover image. + hpi.cloud.common.v1test.Image cover = 5; + + // Required. The description (HTML). + string description = 6; - // Required. The description. - string description = 3; + // Different ways children are displayed within this info bit. + enum ChildDisplay { + NONE = 0; + LIST = 1; + PREVIEWS = 2; + } + + // Required. Defines how child info bits are displayed. + ChildDisplay child_display = 7; // IDs of the actions of this info bit. - repeated string action_ids = 4; + repeated string action_ids = 8; + + // Tags for categorizing this info bit. + repeated string tag_ids = 9; } +// A tag by which info bits can be organized and filtered. +message InfoBitTag { + // Required, output only. The unique ID of this tag. + string id = 1; + + // Required. The title of this tag. + string title = 2; +} + + // An action of an info bit. message Action { // Required, output only. The unique ID of this info bit. @@ -32,18 +66,18 @@ message Action { // The URL pointing to an icon. string icon = 3; - message Link { - // Required. The URL. - string url = 1; - } - - message Text { - // Required. The text to show (HTML). - string content = 1; - } - oneof type { - Link link = 4; - Text text = 5; + LinkAction link = 4; + TextAction text = 5; } } + +message LinkAction { + // Required. The URL to open. + string url = 1; +} + +message TextAction { + // Required. The text to show (HTML). + string content = 1; +} diff --git a/hpi/cloud/myhpi/v1test/myhpi_service.proto b/hpi/cloud/myhpi/v1test/myhpi_service.proto index ffbe715..16e05b8 100644 --- a/hpi/cloud/myhpi/v1test/myhpi_service.proto +++ b/hpi/cloud/myhpi/v1test/myhpi_service.proto @@ -17,6 +17,13 @@ service MyHpiService { rpc GetInfoBit (GetInfoBitRequest) returns (InfoBit); + // Lists tags. + rpc ListInfoBitTags (ListInfoBitTagsRequest) returns (ListInfoBitTagsResponse); + + // Gets a tag. + rpc GetInfoBitTag (GetInfoBitTagRequest) returns (InfoBitTag); + + // Lists actions. rpc ListActions (ListActionsRequest) returns (ListActionsResponse); @@ -24,29 +31,83 @@ service MyHpiService { rpc GetAction (GetActionRequest) returns (Action); } + // Request message for listing bits of information using [ListInfoBits][hpi.cloud.myhpi.v1test.MyHpiService.ListInfoBits]. message ListInfoBitsRequest { + // The maximum number of info bits to return in the response. + int32 page_size = 1; + + // A pagination token returned from a previous call to `ListInfoBits` + // that indicates where this listing should continue from. + string page_token = 2; + + // The ID of the parent info bit. If specified, only child info bits will be + // returned. + string parent_id = 3; } // Response message for listing bits of information using [ListInfoBits][hpi.cloud.myhpi.v1test.MyHpiService.ListInfoBits]. message ListInfoBitsResponse { + // A possibly paginated list of info bits. repeated InfoBit info_bits = 1; + + // Token to retrieve the next page of results, or empty if there are no + // more results. + string next_page_token = 2; } // Request message for [GetInfoBit][hpi.cloud.myhpi.v1test.MyHpiService.GetInfoBit]. message GetInfoBitRequest { - // Required. The InfoBit ID. + // Required. The info bit ID. + string id = 1; +} + + +// Request message for listing tags using [ListInfoBitTags][hpi.cloud.myhpi.v1test.MyHpiService.ListInfoBitTags]. +message ListInfoBitTagsRequest { + // The maximum number of tags to return in the response. + int32 page_size = 1; + + // A pagination token returned from a previous call to `ListInfoBitTags` + // that indicates where this listing should continue from. + string page_token = 2; +} + +// Response message for listing tags using [ListInfoBitTags][hpi.cloud.myhpi.v1test.MyHpiService.ListInfoBitTags]. +message ListInfoBitTagsResponse { + // A possibly paginated list of tags. + repeated InfoBitTag tags = 1; + + // Token to retrieve the next page of results, or empty if there are no + // more results. + string next_page_token = 2; +} + +// Request message for [GetInfoBitTag][hpi.cloud.myhpi.v1test.MyHpiService.GetInfoBitTag]. +message GetInfoBitTagRequest { + // Required. The tag ID. string id = 1; } // Request message for listing actions using [ListActions][hpi.cloud.myhpi.v1test.MyHpiService.ListActions]. message ListActionsRequest { + // The maximum number of actions to return in the response. + int32 page_size = 1; + + // A pagination token returned from a previous call to `ListActions` + // that indicates where this listing should continue from. + string page_token = 2; } // Response message for listing actions using [ListActions][hpi.cloud.myhpi.v1test.MyHpiService.ListActions]. message ListActionsResponse { - repeated Action Actions = 1; + // A possibly paginated list of actions. + repeated Action actions = 1; + + // Token to retrieve the next page of results, or empty if there are no + // more results. + string next_page_token = 2; } // Request message for [GetAction][hpi.cloud.myhpi.v1test.MyHpiService.GetAction]. From d9d5ce4ca0403b04b86edc8eccb4dd372dfb92e9 Mon Sep 17 00:00:00 2001 From: Jonas Wanke Date: Tue, 1 Oct 2019 12:02:04 +0200 Subject: [PATCH 5/6] docs: show GitHub Release badge in readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c337145..4a6e9b8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # hpi-cloud-apis [![Build Status](https://travis-ci.com/HPI-de/hpi-cloud-apis.svg?branch=dev)](https://travis-ci.com/HPI-de/hpi-cloud-apis) -[![Download](https://api.bintray.com/packages/hpi/hpi-cloud-mvn/hpi-cloud/images/download.svg)](https://bintray.com/hpi/hpi-cloud-mvn/hpi-cloud/_latestVersion) +[![GitHub Release](https://img.shields.io/github/v/release/hpi-de/hpi-cloud-apis?include_prereleases&sort=semver&label=Release)](https://github.com/HPI-de/hpi-cloud-apis/releases) +[![Bintray](https://img.shields.io/bintray/v/hpi/hpi-cloud-mvn/hpi-cloud?label=Bintray)](https://bintray.com/hpi/hpi-cloud-mvn/hpi-cloud/_latestVersion) This repository contains the original interface definitions of public HPI Cloud APIs that support the gRPC protocol. Reading the original interface definitions can provide a better understanding of HPI Cloud APIs and help you to utilize them more efficiently. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts. From 809e5665ee60986109e12a0cb8ea718a008e160a Mon Sep 17 00:00:00 2001 From: Jonas Wanke Date: Tue, 1 Oct 2019 12:02:45 +0200 Subject: [PATCH 6/6] chore: prepare release --- .unicornfig.yml | 2 +- CHANGELOG.md | 8 +++++++- build.gradle | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.unicornfig.yml b/.unicornfig.yml index 7ce5a3e..f7e00c0 100644 --- a/.unicornfig.yml +++ b/.unicornfig.yml @@ -7,5 +7,5 @@ description: "This repository contains the original interface definitions of pub \ definitions can provide a better understanding of HPI Cloud APIs and help you\ \ to utilize them more efficiently. You can also use these definitions with open\ \ source tools to generate client libraries, documentation, and other artifacts." -version: "0.0.7" +version: "0.0.8" githubName: "HPI-de/hpi-cloud-apis" diff --git a/CHANGELOG.md b/CHANGELOG.md index b51c711..eb97877 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +## [0.0.8] - 2019-10-01 +### BREAKING CHANGES +- **course:** support multiple lecturers +- **myhpi:** restructure MyHPI + ## [0.0.7] - 2019-09-05 ### BREAKING CHANGES - **course, food, news:** support pagination @@ -75,7 +80,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. Initial release with NewsService. -[Unreleased]: https://github.com/HPI-de/hpi-cloud-apis/compare/0.0.7...dev +[Unreleased]: https://github.com/HPI-de/hpi-cloud-apis/compare/0.0.8...dev +[0.0.8]: https://github.com/HPI-de/hpi-cloud-apis/compare/0.0.7...0.0.8 [0.0.7]: https://github.com/HPI-de/hpi-cloud-apis/compare/0.0.6...0.0.7 [0.0.6]: https://github.com/HPI-de/hpi-cloud-apis/compare/0.0.5...0.0.6 [0.0.5]: https://github.com/HPI-de/hpi-cloud-apis/compare/0.0.4...0.0.5 diff --git a/build.gradle b/build.gradle index 2209d57..b660af8 100644 --- a/build.gradle +++ b/build.gradle @@ -35,7 +35,7 @@ ext { githubReleaseNotes = 'CHANGELOG.md' allLicenses = ["Apache-2.0"] - libraryVersion = "0.0.7" + libraryVersion = "0.0.8" } task sourcesJar(type: Jar, dependsOn: classes) {