Skip to content

Commit

Permalink
build based on 571d927
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 19, 2023
1 parent de1b31d commit ab406e3
Show file tree
Hide file tree
Showing 13 changed files with 78 additions and 61 deletions.
2 changes: 1 addition & 1 deletion .documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2023-09-15T15:17:03","documenter_version":"1.0.0"}}
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2023-10-19T17:39:46","documenter_version":"1.1.1"}}
2 changes: 1 addition & 1 deletion Alerts.html
View file

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions BeaconAPI.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Sending Beacons · mPulseAPI.jl Documentation</title><meta name="title" content="Sending Beacons · mPulseAPI.jl Documentation"/><meta property="og:title" content="Sending Beacons · mPulseAPI.jl Documentation"/><meta property="twitter:title" content="Sending Beacons · mPulseAPI.jl Documentation"/><meta name="description" content="Documentation for mPulseAPI.jl Documentation."/><meta property="og:description" content="Documentation for mPulseAPI.jl Documentation."/><meta property="twitter:description" content="Documentation for mPulseAPI.jl Documentation."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script><link href="favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">mPulseAPI.jl Documentation</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="index.html">mPulseAPI.jl Documentation</a></li><li><a class="tocitem" href="RepositoryAPI.html">RepositoryAPI</a></li><li><a class="tocitem" href="Alerts.html">Alerts &amp; Anomaly Detection Models</a></li><li><a class="tocitem" href="QueryAPI.html">QueryAPI</a></li><li><a class="tocitem" href="apiToken.html">How to generate an mPulse API Token</a></li><li><a class="tocitem" href="caching.html">Object caching</a></li><li><a class="tocitem" href="exceptions.html">Exceptions</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="BeaconAPI.html">Sending Beacons</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="BeaconAPI.html">Sending Beacons</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/akamai/mPulseAPI.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/akamai/mPulseAPI.jl/blob/main/docs/src/BeaconAPI.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Sending-Beacons"><a class="docs-heading-anchor" href="#Sending-Beacons">Sending Beacons</a><a id="Sending-Beacons-1"></a><a class="docs-heading-anchor-permalink" href="#Sending-Beacons" title="Permalink"></a></h1><p>mPulseAPI.jl uses the mPulse <a href="https://techdocs.akamai.com/mpulse/reference/beacons#rest-api">REST Beacon API</a> to send beacons.</p><p>You first need to make a config request using <a href="BeaconAPI.html#mPulseAPI.getBeaconConfig-Tuple{AbstractString, AbstractString}"><code>mPulseAPI.getBeaconConfig</code></a> and then include that config in your call to <a href="BeaconAPI.html#mPulseAPI.sendBeacon-Tuple{Dict, Dict}"><code>mPulseAPI.sendBeacon</code></a> along with other beacon parameters.</p><p>Beacon parameters may be named by label or name.</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="mPulseAPI.CONFIG_URL" href="#mPulseAPI.CONFIG_URL"><code>mPulseAPI.CONFIG_URL</code></a> — <span class="docstring-category">Constant</span></header><section><div><p>Base URL for config.json requests</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/akamai/mPulseAPI.jl/blob/571d9278dc24e82247fd6e3e76b0bb16de98dfe2/src/BeaconAPI.jl#L1-L3">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="mPulseAPI.getBeaconConfig-Tuple{AbstractString, AbstractString}" href="#mPulseAPI.getBeaconConfig-Tuple{AbstractString, AbstractString}"><code>mPulseAPI.getBeaconConfig</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Fetch beacon configuration for an mPulse APP using the <a href="https://techdocs.akamai.com/mpulse/reference/beacons#rest-api">Beacon API</a> Caches the result for whatever is specified in <code>Cache-control: max-age</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/akamai/mPulseAPI.jl/blob/571d9278dc24e82247fd6e3e76b0bb16de98dfe2/src/BeaconAPI.jl#L6-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="mPulseAPI.sendBeacon-Tuple{Dict, Dict}" href="#mPulseAPI.sendBeacon-Tuple{Dict, Dict}"><code>mPulseAPI.sendBeacon</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Send a beacon to mPulse</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/akamai/mPulseAPI.jl/blob/571d9278dc24e82247fd6e3e76b0bb16de98dfe2/src/BeaconAPI.jl#L47-L49">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Thursday 19 October 2023 17:39">Thursday 19 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit ab406e3

Please sign in to comment.