in component-test/src/main/java/org/apache/fineract/cn/accounting/LedgerApiDocumentation.java [223:261]
public void documentFindLedger ( ) throws Exception {
final Ledger ledger = LedgerGenerator.createRandomLedger();
ledger.setIdentifier("7200");
ledger.setName("Name of" + ledger.getIdentifier());
ledger.setDescription("Description of " + ledger.getIdentifier());
this.testSubject.createLedger(ledger);
this.eventRecorder.wait(EventConstants.POST_LEDGER, ledger.getIdentifier());
Gson gson = new Gson();
this.mockMvc.perform(get("/ledgers/" + ledger.getIdentifier())
.contentType(MediaType.APPLICATION_JSON_VALUE)
.accept(MediaType.ALL_VALUE))
.andExpect(status().isOk())
.andDo(document("document-find-ledger", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()),
responseFields(
fieldWithPath("type").description("AccountType").description("Type of first ledger " +
" + \n" +
" + \n" +
" *enum* _AccountType_ { + \n" +
" ASSET, + \n" +
" LIABILITY, + \n" +
" EQUITY, + \n" +
" REVENUE, + \n" +
" EXPENSE + \n" +
"}"),
fieldWithPath("identifier").type("String").description("first ledger identifier"),
fieldWithPath("name").type("String").description("first ledger name"),
fieldWithPath("description").type("String").description("description of first ledger"),
fieldWithPath("subLedgers").type("List<Ledger>").description("list of sub ledgers"),
fieldWithPath(".parentLedgerIdentifier").description("first ledger's parent "),
fieldWithPath("totalValue").type("String").description("Total Value of first ledger"),
fieldWithPath("createdOn").type("String").description("date first ledger was created"),
fieldWithPath("createdBy").type("String").description("employee who created first ledger"),
fieldWithPath("lastModifiedOn").type("String").description("date first ledger was modified"),
fieldWithPath("lastModifiedBy").type("String").description("employee who last modified first ledger"),
fieldWithPath("showAccountsInChart").type("Boolean").description("Should ledger be shown in charts ?")
)));
}