bukalapak/snowboard

Feature Request: HTML anchors (hyperlinks) to the API endpoints' parts of documentation

iworker opened this issue · 0 comments

For example, I created Get Resource [GET /resources/{resourceId}] endpoint and I want to create a hyperlink to this part of API documentation in different endpoint. But I can't do it because hyperlinks are not supported.

It may looks like:

## Resources

### Get Resource [GET /resources/{resourceId}]

... some documentation ...

...

## Parent Resources

### Get Parent Resource [GET /parentResources/{parentResourceId}]

`childResource` – see details in [get resource](/Resources/Get Resource)

... some documentation ...

Where [get resource](/Resources/Get Resource) is a hyperlink to the Get Resource endpoint documentation.

As I understand, currently it's impossible to create such kind of hyperlinks.