Skip to content

Commit

Permalink
Fix proto to pass Project and DocumentSummary cleanly
Browse files Browse the repository at this point in the history
  • Loading branch information
@raararaara
raararaara committed Oct 16, 2024
1 parent d97f668 commit 2c225c7
Show file tree
Hide file tree
Showing 6 changed files with 262 additions and 83 deletions.
205 changes: 195 additions & 10 deletions api/docs/yorkie/v1/system.openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,31 +81,216 @@ components:
type: string
title: Connect Error
type: object
yorkie.v1.SystemServiceDetachDocumentRequest:
google.protobuf.Timestamp:
additionalProperties: false
description: |-
A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.
All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a [24-hour linear
smear](https://developers.google.com/time/smear).
The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from [RFC
3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
# Examples
Example 1: Compute Timestamp from POSIX `time()`.
Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);
Example 2: Compute Timestamp from POSIX `gettimeofday()`.
struct timeval tv;
gettimeofday(&tv, NULL);
Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);
Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
long millis = System.currentTimeMillis();
Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();
Example 5: Compute Timestamp from Java `Instant.now()`.
Instant now = Instant.now();
Timestamp timestamp =
Timestamp.newBuilder().setSeconds(now.getEpochSecond())
.setNanos(now.getNano()).build();
Example 6: Compute Timestamp from current time in Python.
timestamp = Timestamp()
timestamp.GetCurrentTime()
# JSON Mapping
In JSON format, the Timestamp type is encoded as a string in the
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).
For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.
In JavaScript, one can convert a Date object to this format using the
standard
[toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
method. In Python, a standard `datetime.datetime` object can be converted
to this format using
[`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's [`ISODateTimeFormat.dateTime()`](
http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
) to obtain a formatter capable of generating timestamps in this format.
format: date-time
type: string
yorkie.v1.DocumentSummary:
additionalProperties: false
description: ""
properties:
clientId:
accessedAt:
$ref: '#/components/schemas/google.protobuf.Timestamp'
additionalProperties: false
description: ""
title: client_id
title: accessed_at
type: object
createdAt:
$ref: '#/components/schemas/google.protobuf.Timestamp'
additionalProperties: false
description: ""
title: created_at
type: object
id:
additionalProperties: false
description: ""
title: id
type: string
key:
additionalProperties: false
description: ""
title: key
type: string
snapshot:
additionalProperties: false
description: ""
title: snapshot
type: string
documentId:
updatedAt:
$ref: '#/components/schemas/google.protobuf.Timestamp'
additionalProperties: false
description: ""
title: updated_at
type: object
title: DocumentSummary
type: object
yorkie.v1.Project:
additionalProperties: false
description: ""
properties:
authWebhookMethods:
additionalProperties: false
description: ""
title: document_id
items:
type: string
title: auth_webhook_methods
type: array
authWebhookUrl:
additionalProperties: false
description: ""
title: auth_webhook_url
type: string
documentKey:
clientDeactivateThreshold:
additionalProperties: false
description: ""
title: document_key
title: client_deactivate_threshold
type: string
projectId:
createdAt:
$ref: '#/components/schemas/google.protobuf.Timestamp'
additionalProperties: false
description: ""
title: created_at
type: object
id:
additionalProperties: false
description: ""
title: id
type: string
name:
additionalProperties: false
description: ""
title: name
type: string
publicKey:
additionalProperties: false
description: ""
title: public_key
type: string
secretKey:
additionalProperties: false
description: ""
title: secret_key
type: string
updatedAt:
$ref: '#/components/schemas/google.protobuf.Timestamp'
additionalProperties: false
description: ""
title: updated_at
type: object
title: Project
type: object
yorkie.v1.SystemServiceDetachDocumentRequest:
additionalProperties: false
description: ""
properties:
clientId:
additionalProperties: false
description: ""
title: client_id
type: string
documentSummary:
$ref: '#/components/schemas/yorkie.v1.DocumentSummary'
additionalProperties: false
description: ""
title: document_summary
type: object
project:
$ref: '#/components/schemas/yorkie.v1.Project'
additionalProperties: false
description: 'TODO(hackerwins): Consider to replace this fields with types.Project,
types.Client, types.DocumentSummary'
title: project_id
type: string
title: project
type: object
title: SystemServiceDetachDocumentRequest
type: object
yorkie.v1.SystemServiceDetachDocumentResponse:
Expand Down
98 changes: 49 additions & 49 deletions api/yorkie/v1/system.pb.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions api/yorkie/v1/system.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ syntax = "proto3";

package yorkie.v1;

import "yorkie/v1/resources.proto";

option go_package = "github.com/yorkie-team/yorkie/api/yorkie/v1;v1";

option java_multiple_files = true;
Expand All @@ -28,11 +30,9 @@ service SystemService {
}

message SystemServiceDetachDocumentRequest {
// TODO(hackerwins): Consider to replace this fields with types.Project, types.Client, types.DocumentSummary
string project_id = 1;
Project project = 1;
string client_id = 2;
string document_id = 3;
string document_key = 4;
DocumentSummary document_summary = 3;
}

message SystemServiceDetachDocumentResponse {}
Loading

0 comments on commit 2c225c7

Please sign in to comment.