mitre-attack / mitre-attack/attack-workbench-rest-api
As a user, I want to be able to reference the API documentation without installing or running the application
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 57
- Forks
- 18
- Avg merge
- 6m
- Merged PRs (30d)
- 2
Description
[Additionally], as a developer of the ATT&CK Workbench REST API I want to be able to share hyperlinks to the API documentation with users of the REST API when they ask questions about the APIs.
We should determine if it is possible to host the REST API documentation somewhere publically for ease of reference.
One possible approach is to pull the Swagger UI's HTML/CSS/JS and host that on GitHub pages, possibly with some sort of CI-deployment system to deploy the docs when pushed to Master. However, the Swagger UI does include interactive elements (i.e the "try it out" buttons) which may invalidate that approach.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the REST API documentation is currently exposed and investigate whether Swagger UI's HTML, CSS, and JavaScript can be hosted publicly on GitHub Pages. Assess a CI deployment from Master and the effect of hosting the interactive "try it out" controls separately. Done means a documented public hyperlink is available or the approach is shown to be infeasible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100