Sync from internal to public. Fixing endpoint issues - Githubissues

MicroStrategy / rest-api-docs

Docs for MicroStrategy REST API

https://MicroStrategy.github.io/rest-api-docs

Apache License 2.0

7 stars 8 forks source link

Sync from internal to public. Fixing endpoint issues #26

Closed xdumstr closed 1 year ago

xdumstr commented 1 year ago

Type of Changes

Adding a script to check the pattern we used for Endpoints. This is a correct example:

Endpoint: [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin)

We detect the following common errors.

Endpoint should be one word.
Should use "Endpoint: " prefix.
Should not use backticks in []
The verb should be valid and all capitalized.
The path starts with /api/
Should always have a link for the Endpoint.

The reachability of the links is not checked in this script.

[ ] New content for the documentation
[x] Modification in the existing documentation
[x] Infrastructure changes (not related to documentation content)

Checklist

[x] My changes are rendered as expected by running yarn start.
[x] My changes follow the style guide.
[x] I have self-reviewed this PR.

Helpful Info