As a user, I want to be able to reference the API documentation without installing or running the application
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript
- Área
- api, documentation
Línea de trabajo
Comienza revisando cómo se expone actualmente la documentación de la REST API e investiga si el HTML, el CSS y el JavaScript de Swagger UI pueden alojarse públicamente en GitHub Pages. Evalúa un despliegue de CI desde Master y el efecto de alojar por separado los controles interactivos "try it out". Se considera completado cuando haya disponible un hipervínculo público documentado o se demuestre que el enfoque no es viable.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
[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.
- Lenguaje dominante
- JavaScript
- Estrellas
- 57
- Forks
- 18
- Merge medio
- 1 d 26 min
- PR fusionados (30 d)
- 7
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de mitre-attack/attack-workbench-rest-api
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 74/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
Todos los issues de mitre-attack/attack-workbench-rest-api
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
answerLoops/answerLoops#344 ·
Los mantenedores suelen responder en 1 día
-
Engineering
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
techmatters/terraso-web-client#3095 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Service process inherits the caller's cwd at first use, holding that folder open on Windows (EBUSY)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
nextcloud/viewer#3424 · 1 comentario ·
Los mantenedores suelen responder en 1 día