Skip to content

Creating snippet for shared model/bean #762

Closed
@hasnainjaved

Description

@hasnainjaved

Is it possible to generate snippet for a nested bean shared between different response structures ?

Address model:

class Address {
 String state;
 Integer postcode;
}

Response from endpoint 1 (R1)

{
  "status": 1,
  "address": {
    "state": "abc",
    "postcode": 3
  }
}

Response from endpoint 2 (R2)

{
  "id": 2,
  "currentAddress": {
    "state": "abc",
    "postcode": 2
  }
}

I would like to generate the snippet for Address model once and reuse it in generated snippets for R1 and R2. Currently the snippet for address is generated multiple times. The docs have a section for reusing a snippet but not sure if that would create a .adoc snippet under a separate path/folder

Posted a question on Stackoverflow 3 months ago but did not get any response.

It's somewhat similar to issue #745 and would be nice to have the ability to create a common section for documenting shared models/beans

Metadata

Metadata

Assignees

No one assigned

    Labels

    for: stack-overflowQuestion that is better suited to Stack Overflowstatus: invalidSuggestion or bug report that we don't feel is valid

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions