MISP
/
misp-website
mirror of https://github.com/MISP/misp-website
2
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #47 from righel/add-openapi-spec-doc-page 

new: add openapi spec page, link it in header and doc page.
pull/48/head
Alexandre Dulaunoy 2021-06-07 17:07:14 +02:00 committed by GitHub
parent 4dca22866b 0f5377a5c5
commit 39b518ade9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
_includes/header.html
View File

@ -65,7 +65,8 @@
<li {% if current[1] == 'documentation' %}class="current"{% endif %}><a href="{{ site.baseurl }}/documentation">Documentation</a>
<ul>
<li><a href="{{ side.baseurl }}/compliance/">Legal and policy compliance</a></li>
<li><a href="{{ site.baseurl }}/research-projects/">Research projects</a></li>
<li><a href="{{ site.baseurl }}/research-projects/">Research projects</a></li>
<li><a href="{{ site.baseurl }}/documentation/openapi">OpenAPI spec</a></li>
</ul>
</li>
<li {% if current[1] == 'tools' %}class="current"{% endif %}><a href="{{ site.baseurl }}/tools">Tools</a></li>

3
_pages/documentation.md
View File

@ -35,6 +35,9 @@ other developers willing to develop their own tools or software supporting the M
* [misp-galaxy-format](https://github.com/MISP/misp-rfc/blob/master/misp-galaxy-format/raw.md.txt) which describes the [galaxy](https://github.com/MISP/misp-galaxy) template format used to expand the threat actor modelling of MISP. Current Internet-Draft: [05](https://datatracker.ietf.org/doc/draft-dulaunoy-misp-galaxy-format/)
* [misp-object-template-format](https://github.com/MISP/misp-rfc/blob/master/misp-object-template-format/raw.md.txt) which describes the [object](https://github.com/MISP/misp-objects) template format to add combined and composite object to the MISP core format. Current Internet-Draft: [02](https://datatracker.ietf.org/doc/draft-dulaunoy-misp-object-template-format/)
### MISP OpenAPI Spec
MISP API OpenAPI spec available is [here](/documentation/openapi).
## Community Support
If you have any issues with MISP core software, [the issue tracking of MISP](https://github.com/MISP/MISP/issues) is handled in GitHub.

8
_pages/openapi.md Normal file
View File

@ -0,0 +1,8 @@
---
title: MISP OpenAPI spec
permalink: /documentation/openapi
layout: default
---
<redoc spec-url='https://raw.githubusercontent.com/MISP/MISP/develop/app/webroot/doc/openapi.yaml'></redoc>
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>