Skip to content

Commit

Permalink
v1.39.0 and SecureConnect
Browse files Browse the repository at this point in the history
  • Loading branch information
dexterlabora committed Nov 2, 2023
1 parent 0572b16 commit d714cf5
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 16 deletions.
23 changes: 23 additions & 0 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,29 @@
}
}
},
{
"title": "Integrated APIs",
"items": [
{
"title": "Overview",
"content": "docs/integrated-apis-overview.md"
},
{
"title": "SecureConnect",
"type": "oas3",
"content": "https://raw.githubusercontent.com/meraki/secure-connect-openapi/main/secure_connect_oas_beta.json",
"config": {

"theme": "meraki",
"expand": 2,
"exampleAsDefault": true,
"groupBy": {
"$remoteModule": "config/group_api_tag.js"
}
}
}
]
},
{
"title": "Libraries & SDKs",
"config": {
Expand Down
22 changes: 22 additions & 0 deletions config/group_api_tag.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
const groupBy = function (operation, meta) {
let path = "";
operation.tags.forEach((t, i) => {
// build path
path += t + "/";
});
path = path.replace(/\/$/, "");
return path;
};

module.exports = groupBy;

// ********************
// testing
// ********************


const testData = {
"tags": ["Posture Profile", "Browser"]
}
console.log(groupBy(testData))
// Posture Profile/Browser
21 changes: 21 additions & 0 deletions docs/integrated-apis-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Overview

In our pursuit to offer a seamless digital experience, we have introduced a new concept of **Integrated APIs** within the `api.meraki.com` namespace.

These APIs are distinctive as they serve as seamless connectors to various systems, effectively bridging the gap between the multitude of software solutions we encounter.

## Features and Considerations

1. **Passthrough Nature:** Integrated APIs are primarily designed to be passthrough conduits to other systems within the api.meraki.com namespace.

2. **Early Access Gated:** Due to the nature of the Integrated API endpoints, they don't fully comply with the Meraki API standards and serve as "Early Access" endpoints.

3. **Fluidity in Design:** Given their early access phase, users should be aware that the Integrated APIs are fluid and subject to changes at any moment. This inherent nature allows us to adapt and innovate faster.

4. **Transitioning Over Time:** We aim to improve and evolve continually. As such, over time, Integrated APIs will either be phased out or replaced by APIs that fully align with the Meraki API standards.

5. **Documentation Process:** Our commitment is to provide a clear understanding of the Integrated API endpoint functionality.

6. **Response Data Inclusion:** The response payload from the Integrated API may consist of data sourced from the various systems it interfaces with.

Integrated APIs, while transitional, play a pivotal role in our current digital ecosystem. They act as the intermediary bridge, ensuring systems communicate effectively. As we progress, we invite our users to explore, utilize, and provide feedback, aiding in the evolution of Meraki's digital solutions.
20 changes: 4 additions & 16 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,11 @@

# Interactive API Docs
# Overview

Use the interactive documentation to explore the Meraki API endpoints.
Use this documentation to explore the API in detail.

Each request will have a complete description of all the required parameters and also allow you to instantly try it out in the online console. Code Templates are also provided for quickly building scripts.

<img src="api.png" width="600px">



## API Key

- A demo API key is added by default to easily kick the tires.

- Add your own API key and parameter values in the **Configuration** menu to test against your own environment.


<img src="../images/interactiveAPIConfig.png" width="600px">
Each request will have a complete description of all the required parameters.

Code Templates are also provided for quickly building scripts.

## API Version

Expand Down

0 comments on commit d714cf5

Please sign in to comment.