123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 |
- <!DOCTYPE HTML><html><head><title>Handling API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/kevinrenskers/raml2html 2.2.0"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script><script type="text/javascript">
- $(document).ready(function() {
- $('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
- hljs.highlightBlock(block);
- });
- $('[data-toggle]').click(function() {
- var selector = $(this).data('target') + ' pre code';
- $(selector).each(function(i, block) {
- hljs.highlightBlock(block);
- });
- });
- // open modal on hashes like #_action_get
- $(window).bind('hashchange', function(e) {
- var anchor_id = document.location.hash.substr(1); //strip #
- var element = $('#' + anchor_id);
- // do we have such element + is it a modal? --> show it
- if (element.length && element.hasClass('modal')) {
- element.modal('show');
- }
- });
- // execute hashchange on first page load
- $(window).trigger('hashchange');
- // remove url fragment on modal hide
- $('.modal').on('hidden.bs.modal', function() {
- try {
- if (history && history.replaceState) {
- history.replaceState({}, '', '#');
- }
- } catch(e) {}
- });
- });
- </script><style>
- .hljs {
- background: transparent;
- }
- .parent {
- color: #999;
- }
- .list-group-item > .badge {
- float: none;
- margin-right: 6px;
- }
- .panel-title > .methods {
- float: right;
- }
- .badge {
- border-radius: 0;
- text-transform: uppercase;
- width: 70px;
- font-weight: normal;
- color: #f3f3f6;
- line-height: normal;
- }
- .badge_get {
- background-color: #63a8e2;
- }
- .badge_post {
- background-color: #6cbd7d;
- }
- .badge_put {
- background-color: #22bac4;
- }
- .badge_delete {
- background-color: #d26460;
- }
- .badge_patch {
- background-color: #ccc444;
- }
- .list-group, .panel-group {
- margin-bottom: 0;
- }
- .panel-group .panel+.panel-white {
- margin-top: 0;
- }
- .panel-group .panel-white {
- border-bottom: 1px solid #F5F5F5;
- border-radius: 0;
- }
- .panel-white:last-child {
- border-bottom-color: white;
- -webkit-box-shadow: none;
- box-shadow: none;
- }
- .panel-white .panel-heading {
- background: white;
- }
- .tab-pane ul {
- padding-left: 2em;
- }
- .tab-pane h2 {
- font-size: 1.2em;
- padding-bottom: 4px;
- border-bottom: 1px solid #ddd;
- }
- .tab-pane h3 {
- font-size: 1.1em;
- }
- .tab-content {
- border-left: 1px solid #ddd;
- border-right: 1px solid #ddd;
- border-bottom: 1px solid #ddd;
- padding: 10px;
- }
- #sidebar {
- margin-top: 30px;
- padding-right: 5px;
- overflow: auto;
- height: 90%;
- }
- .top-resource-description {
- border-bottom: 1px solid #ddd;
- background: #fcfcfc;
- padding: 15px 15px 0 15px;
- margin: -15px -15px 10px -15px;
- }
- .resource-description {
- border-bottom: 1px solid #fcfcfc;
- background: #fcfcfc;
- padding: 15px 15px 0 15px;
- margin: -15px -15px 10px -15px;
- }
- .resource-description p:last-child {
- margin: 0;
- }
- .list-group .badge {
- float: left;
- }
- .method_description {
- margin-left: 85px;
- }
- .method_description p:last-child {
- margin: 0;
- }
- .list-group-item {
- cursor: pointer;
- }
- .list-group-item:hover {
- background-color: #f5f5f5;
- }
- </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>Handling API documentation <small>version v1</small></h1><p>http://dddsample.marcusoncode.se/handling/v1</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="incidents" class="panel-title">/incidents</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_incidents"><span class="parent"></span>/incidents</a> <span class="methods"><a href="#incidents_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_incidents" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#incidents_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Register a handling incident.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="incidents_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/incidents</h4></div><div class="modal-body"><div class="alert alert-info"><p>Register a handling incident.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#incidents_post_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="incidents_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
- "completion_time": "0001-01-01T00:00:00Z",
- "tracking_id": "ABC123",
- "voyage": "V100",
- "location" "CNHKG",
- "event_type": "Unload"
- }
- </code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#incidents">/incidents</a></li></ul></div></div></div></div></body></html>
|