Skip to content
This repository has been archived by the owner on Feb 1, 2022. It is now read-only.

Commit

Permalink
Merge branch 'release/0.0.8'
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasWanke committed Oct 1, 2019
2 parents 2fcc9d5 + 809e566 commit 1501e6e
Show file tree
Hide file tree
Showing 8 changed files with 130 additions and 26 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Generated files
src/
lib/proto/
gen/

# Gradle
.gradle
Expand Down
2 changes: 1 addition & 1 deletion .unicornfig.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
11 changes: 10 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,18 @@ 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

### Added
- **crashreporting:** add Crash Reporting definitions

### Removed
- **food:** remove MenuItem.substitution

Expand Down Expand Up @@ -72,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
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
4 changes: 2 additions & 2 deletions hpi/cloud/course/v1test/course.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
66 changes: 50 additions & 16 deletions hpi/cloud/myhpi/v1test/info_bit.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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.
Expand All @@ -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;
}
65 changes: 63 additions & 2 deletions hpi/cloud/myhpi/v1test/myhpi_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -17,36 +17,97 @@ 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);

// Gets a action.
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].
Expand Down

0 comments on commit 1501e6e

Please sign in to comment.