Skip to content

Ability to track MD links in the spec #5204

@szabosteve

Description

@szabosteve

🚀 Feature Proposal

A tool that scans ts files within the specification folder of the repository and reports all Markdown links ([link text](url)) found in those files. The output should indicate:

  • Which files contain links
  • The number of links in each file
  • The line number where the links are located
  • The total number of markdown links across the folder

Motivation

An OpenAPI property can have only one external link attached. If we want to add more references to a description, for example, we need to add Markdown links. It would be important to have information about those links in the spec files in case we need to do mass redirects or want to check if links are valid or not.

Example

For example, we'd like to carry out an audit to see if the links in the API docs are all valid. It would be very hard to locate all the Markdown links in the spec files without a tool like this.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions