Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include the revision number in the getFile response #310

Closed
minwoox opened this issue Nov 15, 2018 · 1 comment
Closed

Include the revision number in the getFile response #310

minwoox opened this issue Nov 15, 2018 · 1 comment
Labels
new feature
Milestone
0.38.0

Comments

@minwoox
Copy link
Member

minwoox commented Nov 15, 2018

We currently do not return the revision of an entry. The reasoning behind this behavior is that the response would contain duplicate 'revision' fields if a user requested more than one entry. Because of that, there's a problem that a user could not notice quickly which version of a file is adapted to his/her service.
To solve this issue, there're two ways as @trustin suggested:

  • Allow some level of duplicate information.
  • Separate the API into two which are for getting a single file and multiple files.

I personaly prefer the second one because I don’t want to include duplicate information and I think there’s not so much people who are using it, so it’s not a big deal.
@minwoox
Copy link
Member Author

minwoox commented Nov 15, 2018

/cc @linxGnu

@trustin trustin added this to the 0.33.0 milestone Nov 16, 2018
@trustin trustin modified the milestones: 0.33.0, 0.34.0 Nov 28, 2018
@minwoox minwoox modified the milestones: 0.34.0, 0.35.0 Dec 24, 2018
@minwoox minwoox modified the milestones: 0.35.0, 0.36.0 Jan 23, 2019
@trustin trustin modified the milestones: 0.36.0, 0.37.0 Mar 8, 2019
@trustin trustin modified the milestones: 0.37.0, 0.38.0 Mar 20, 2019
trustin added a commit to trustin/centraldogma that referenced this issue Apr 3, 2019
@trustin
Add revision property to EntryDto
e81708b 
Motivation:

We currently do not return the revision of an entry. The reasoning
behind this behavior is that the response would contain duplicate
'revision' fields if a user requested more than one entry. Because of
that, there's a problem that a user could not notice quickly which
version of a file is loaded into his/her service.

Modifications:

- Added `revision` property to `EntryDto`
- Miscellaneous:
  - Used `HttpHeaderNames.PREFER` which reappeared Armeria 0.83.0
  - Used `HttpData.toStringUtf8()` instead of `.content().toStringUtf8()`

Result:

- Closes line#310
@trustin trustin mentioned this issue Apr 3, 2019
Merged
trustin added a commit that referenced this issue Apr 3, 2019
@trustin
Add revision property to EntryDto (#378)
e072bcc 
Motivation:

We currently do not return the revision of an entry. The reasoning
behind this behavior is that the response would contain duplicate
'revision' fields if a user requested more than one entry. Because of
that, there's a problem that a user could not notice quickly which
version of a file is loaded into his/her service.

Modifications:

- Added `revision` property to `EntryDto`
- Miscellaneous:
  - Used `HttpHeaderNames.PREFER` which reappeared in Armeria 0.83.0
  - Used `HttpData.toStringUtf8()` instead of `.content().toStringUtf8()`

Result:

- Closes #310
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
new feature
Projects
None yet
Milestone
0.38.0
Development

No branches or pull requests
2 participants
@trustin @minwoox