STYLE-GUIDE.md

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
OLMIS-6408: Information about pageable validator added to the documentation

Add HTTP caching and DTOs to style guide

Cross reference to performance docs. If HTTP caching is being implemented, need to check and potentially fix DTOs.

add note about audit log requirement

This has been a gap in documenting our non-functional requirement around audit logging.

some fixes to java conventions

Remove link to community princples doc

It'll be in RTD

add restful representation terms and details to style

Update style guide: UUIDs should end in "Id"

OLMIS-832 Update based on review feedback

Wordsmithing.

OLMIS-832 Add info about Transifex and the build

Add info about what happens in Transifex when the message source is modified.

Looks good, thanks.

Looks good, thanks.

Hi Chongsun - thank you again for your great feedback. I’ve addressed it within WidgetController and STYLE-GUIDE.md, and hope you can please review the result. At Brandon’s suggestion, I’ve also at...

Hi Chongsun - thank you again for your great feedback. I’ve addressed it within WidgetController and STYLE-GUIDE.md, and hope you can please review the result. At Brandon’s suggestion, I’ve also attached “For_the_Dev_Forum.docx,” which I hope you can please review. If everything looks good to you, I think we’ll be able to close OLMIS-1605. Thanks again!

Good catch - thank you very much! I've fixed that error.

Good catch - thank you very much! I've fixed that error.

Good point. I've standardized on the static methods as per your preference.

Good point. I've standardized on the static methods as per your preference.

OLMIS-1605: Update style guide

A couple of stuff to resolve; otherwise looks good.

A couple of stuff to resolve; otherwise looks good.

Actually we should return a 404 if the resource does not exist, which is what we do for the widget resource in the code.

Actually we should return a 404 if the resource does not exist, which is what we do for the widget resource in the code.

Let's standardize ResponseEntity returns. The handleNotFound returns a new ResponseEntity object. I prefer using this pattern (ResponseEntity static methods).

Let's standardize ResponseEntity returns. The handleNotFound returns a new ResponseEntity object. I prefer using this pattern (ResponseEntity static methods).

The relevant changes here are pretty similar to what you (Chongsun) saw as part of review FEOLMIS-971. The RAML is admittedly sparse. There wasn't much in this file to begin with, and I added littl...

The relevant changes here are pretty similar to what you (Chongsun) saw as part of review FEOLMIS-971. The RAML is admittedly sparse. There wasn't much in this file to begin with, and I added little beyond the minimum necessary to show audit logging.

Although audit logging rather than pagination is the subject of this review, the former has some dependency on the later. That's why this class has been included. This version of the class has alre...

Although audit logging rather than pagination is the subject of this review, the former has some dependency on the later. That's why this class has been included. This version of the class has already been vetted as part of another review.

For all intents and purposes, this version of auditLogEntry is identical to the one you (Chongsun) saw as part of review FEOLMIS-971.

For all intents and purposes, this version of auditLogEntry is identical to the one you (Chongsun) saw as part of review FEOLMIS-971.

For all intents and purposes, this version of the AuditLogInitializer is identical to the one you (Chongsun) saw as part of review FEOLMIS-971.

For all intents and purposes, this version of the AuditLogInitializer is identical to the one you (Chongsun) saw as part of review FEOLMIS-971.

For all intents and purposes, this version of the BaseController is identical to the one you (Chongsun) saw as part of review FEOLMIS-971.

For all intents and purposes, this version of the BaseController is identical to the one you (Chongsun) saw as part of review FEOLMIS-971.

Add Audit Logging to Template-Service
Add Audit Logging to Template-Service
OLMIS-1605: Add audit log support

This commit introduces support for basic audit logging. In order to show this feature, it associates WidgetRepository with JaVers so that changes persisted to Widgets are logged. It also adds an endpoint at /api/widgets/{id}/auditLog to retrieve a list of these changes.

  1. … 10 more files in changeset.
I added a commit to add a few more words that make a section and bullet point a little clearer to me. This looks good, thanks.

I added a commit to add a few more words that make a section and bullet point a little clearer to me.

This looks good, thanks.

Correct.

Correct.