Implement documentation of project JSON models

Details

  • Type: Task Task
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 1.15
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None

Description

  • Based on new internal JSON model
  • Document all JSON "schemas" found in the model
  • Link to JSON types from ReSTful resources and RPC web-methods

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Steven Cummings added a comment -

Primary implementation is complete, and the branch has been merged to trunk. Unless there are objections I will leave this bug open while I round out the testing.

Show
Steven Cummings added a comment - Primary implementation is complete, and the branch has been merged to trunk. Unless there are objections I will leave this bug open while I round out the testing.
Hide
Permalink
Ryan Heaton added a comment -

moving to 1.17 in preparation of the 1.16 rc1 cut.

Show
Ryan Heaton added a comment - moving to 1.17 in preparation of the 1.16 rc1 cut.
Hide
Permalink
Steven Cummings added a comment -

Now that I've been trying this on larger projects and uncovering and fixing little problems here and there I think this is coming along fairly nicely.

What remains:

  • Round out the testing
  • Ensure jackson's jaxb-to-JSON serialization is respected
  • Document the JSON generation feature (ENUNCIATE-354)
  • Ensure the documentation filename derived from a JSON schema ID is "sanitized" as a valid filename.
  • Think through the type-mapping strategy I've currently "hacked in" and start thinking harder about gson/jsonlib modules for enunciate

So the 1.16 release was perhaps over-zealous, but I think I should be fine for 1.17. If I can get that doc out there over the holiday week then perhaps others could give these new features a try and let me know if there are other problems that I've missed.

Show
Steven Cummings added a comment - Now that I've been trying this on larger projects and uncovering and fixing little problems here and there I think this is coming along fairly nicely. What remains:
  • Round out the testing
  • Ensure jackson's jaxb-to-JSON serialization is respected
  • Document the JSON generation feature (ENUNCIATE-354)
  • Ensure the documentation filename derived from a JSON schema ID is "sanitized" as a valid filename.
  • Think through the type-mapping strategy I've currently "hacked in" and start thinking harder about gson/jsonlib modules for enunciate
So the 1.16 release was perhaps over-zealous, but I think I should be fine for 1.17. If I can get that doc out there over the holiday week then perhaps others could give these new features a try and let me know if there are other problems that I've missed.
Hide
Permalink
Ryan Heaton added a comment -

I'll be creating a release candidate tomorrow (18th). If any of these changes need to be in there, please check-in by tomorrow morning

Show
Ryan Heaton added a comment - I'll be creating a release candidate tomorrow (18th). If any of these changes need to be in there, please check-in by tomorrow morning
Hide
Permalink
Ryan Heaton added a comment -

moving to 1.18

Show
Ryan Heaton added a comment - moving to 1.18
Hide
Permalink
Steven Cummings added a comment -

Bump I haven't gone away Just need to find time to tie up the final loose ends...

Show
Steven Cummings added a comment - Bump I haven't gone away Just need to find time to tie up the final loose ends...

People

  • Assignee:
    Ryan Heaton
    Reporter:
    Steven Cummings
Vote (1)
Watch (2)

Dates

  • Created:
    Updated: