Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make documentationUrl available as part of Javascript API linting result #1488

Open
1 task
apiglue opened this issue Jan 27, 2021 · 0 comments · May be fixed by #2443
Open
1 task

make documentationUrl available as part of Javascript API linting result #1488

apiglue opened this issue Jan 27, 2021 · 0 comments · May be fixed by #2443
Labels
chore

Comments

@apiglue
Copy link

apiglue commented Jan 27, 2021 •
edited

Chore summary
When using a custom ruleset which utilizes a different documentUrl per rule, the Javascript API and the CLI linting results should include the respective rule documentUrl.

Tasks

  • Make documentUrl available as part of a linting results for

.i.e for Javascript API:

        {
            "code": "operation-description",
            "message": "Operation `description` must be present and non-empty string.",
            **"documentUrl": "https://mydomain.io/operation-description.html",**
            "path": [
                "paths",
                "/contacts/",
                "post"
            ],
            "severity": 1,
            "range": {
                "start": {
                    "line": 122,
                    "character": 13
                },
                "end": {
                    "line": 127,
                    "character": 25
                }
            }
        },

Additional context
Add any other context about the chore here.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
chore
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(core): add documentUrl to JS api and cli formatters dweber019/spectral
1 participant
@apiglue