Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
FolderOrigin-RevId: /Users/jorunfa/projects/loltel/.
  • Loading branch information
Working Group Two Maintainers authored and jorunfa committed Jan 16, 2024
1 parent ac9d37e commit b38b5d0
Show file tree
Hide file tree
Showing 20 changed files with 142 additions and 111 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@

END OF TERMS AND CONDITIONS

Copyright 2019 Working Group Two
Copyright 2024 Cisco

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# WGTwo API docs v0
# API docs v0

This is the project for WGTwo API docs v0, hosted at [v0.docs.wgtwo.com/](https://v0.docs.wgtwo.com/).
Prior to 2023-03-29 these docs were hosted on docs.wgtwo.com.
The actual docs.wgtwo.com code can be found in loltel/public-api-docs.
[v0.docs.wgtwo.com/](https://v0.docs.wgtwo.com/).

## Contributing
Check out [CONTRIBUTING.md](CONTRIBUTING.md) and add your content to [docs/](docs/)
Expand Down
2 changes: 1 addition & 1 deletion docs/events-how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sourceExamples:

## Overview

The event API allows you to subscribe to a variety of different events generated by Working Group Two's systems.
The event API allows you to subscribe to a variety of different events generated by Cisco's systems.

The examples will start a subscription to voice and voicemail events, which includes call initiated, call ended and
new voicemail received.
Expand Down
4 changes: 2 additions & 2 deletions docs/metrics-how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sourceExamples:
# Accessing Metrics

## Overview
Working Group Two exposes metrics that can help operators getting some operational insight. This data is exposed using the [OpenMetrics text format](https://openmetrics.io/).
The platform exposes metrics that can help operators getting some operational insight. This data is exposed using the [OpenMetrics text format](https://openmetrics.io/).

This text format is the same as exposed by Prometheus. In addition to being supported by Prometheus, many other systems
has OpenMetrics integrations such as
Expand All @@ -35,7 +35,7 @@ curl -s -u ${CLIENT_ID}:${CLIENT_SECRET} https://api.wgtwo.com/metrics/v1
```

## Get metrics, Prometheus
The below Prometheus config will scrape the metric endpoint from Working Group Two every 30 seconds,
The below Prometheus config will scrape the metric endpoint every 30 seconds,
fetching all available time series. Note that the configuration will contain secrets.

See: [prometheus.io › Configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/)
Expand Down
10 changes: 5 additions & 5 deletions docs/oauth2-subscriber-deauthorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ so that they can easily deauthorize an application.
> A sequence diagram is included [here](#flow-chart).
1. The user MUST be able to prompt the third party application (app) to revoke all consents it has given to the app (i.e. clicking a button).
2. The app SHALL request a _revoke consent magic link_ from _Working Group Two ID_ (WGTWO ID), supplying a [random, non-guessable `state`](https://auth0.com/docs/protocols/state-parameters#csrf-attacks).
3. The app SHALL redirect the user to the given link, which opens a WGTWO ID webpage.
2. The app SHALL request a _revoke consent magic link_ from Cisco, supplying a [random, non-guessable `state`](https://auth0.com/docs/protocols/state-parameters#csrf-attacks).
3. The app SHALL redirect the user to the given link, which opens the ID webpage.
4. The user MAY confirm/cancel revoking consent (the user MAY also just close/leave the webpage).
5. The user is redirected back to the app, and the app MUST validate the state, and if valid MAY delete local user content (i.e. from a database) and wipe user sessions to reflect that the app no longer has access to the users' WGTWO data/APIs.
5. The user is redirected back to the app, and the app MUST validate the state, and if valid MAY delete local user content (i.e. from a database) and wipe user sessions to reflect that the app no longer has access to the users' data/APIs.

## Redirect
The user will be redirected back to the given redirect URI after logout with the query parameter `state` with the given
state value. A query parameter for `error` will be included in case of errors or the user cancelling the flow.
state value. A query parameter for `error` will be included in case of errors or the user cancelling the flow.

## Generate a revoke consent magic link
This endpoint requires authentication by an OAuth2 access token issued to your client using the `client_credentials` grant.
This endpoint requires authentication by an OAuth2 access token issued to your client using the `client_credentials` grant.

You also need to include a valid user access token.

Expand Down
2 changes: 1 addition & 1 deletion docs/subscriber-location-how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following `status` codes are defined:
| `CODE_OK` | 1 | Indicates that the attachment was successful. |
| `CODE_ABSENT_PROFILE` | 2 | Currently not used |
| `CODE_ABSENT_SUBSCRIBER` | 3 | Currently not used |
| `CODE_UNKNOWN_PROFILE` | 4 | Indicates that the subscriber was not allowed to attach because it is not provisioned on the WGTWO platform. |
| `CODE_UNKNOWN_PROFILE` | 4 | Indicates that the subscriber was not allowed to attach because it is not provisioned on the platform. |
| `CODE_BLOCKED_PROFILE` | 5 | Indicates that the subscriber was not allowed to attach because it is inactive/blocked |
| `CODE_ROAMING_NOT_ALLOWED` | 6 | Indicates that the subscriber was not allowed to attach because it either was missing the roaming services or because the roaming profile of the subscriber did not allow the it to roam at that location. |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ private val subscriptionProfileApi = SubscriptionProfileApi(apiClient)

fun main() {
val request = UpdateSubscriptionRequest().apply {
bssid = "IDENTIFIER PROVIDED BY WORKING GROUP TWO"
bssid = "IDENTIFIER PROVIDED BY CISCO"
msisdn = "47xxxxxxxx"
services = UpdateSubscriptionRequestServices().apply {
delete = listOf(NameEnum.ROAMING_DATA)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ private val subscriptionProfileApi = SubscriptionProfileApi(apiClient)

fun main() {
val request = UpdateSubscriptionRequest().apply {
bssid = "IDENTIFIER PROVIDED BY WORKING GROUP TWO"
bssid = "IDENTIFIER PROVIDED BY CISCO"
msisdn = "47xxxxxxxx"
services = UpdateSubscriptionRequestServices().apply {
add = listOf(
Expand Down
42 changes: 21 additions & 21 deletions gridsome.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const nodeExternals = require('webpack-node-externals')
const nodeExternals = require("webpack-node-externals");

// This is where project configuration and plugin options are located.
// Learn more: https://gridsome.org/docs/config
Expand All @@ -7,19 +7,19 @@ const nodeExternals = require('webpack-node-externals')
// To restart press CTRL + C in terminal and run `gridsome develop`

module.exports = {
siteName: 'WGTWO API v0 docs',
siteUrl: 'https://v0.docs.wgtwo.com',
icon: './src/favicon.svg',
siteName: "WGTWO API v0 docs",
siteUrl: "https://v0.docs.wgtwo.com",
icon: "./src/favicon.png",

chainWebpack(config, { isServer }) {
config.module.rules.delete('svg')
config.module.rule('svg')
config.module.rules.delete("svg");
config.module.rule("svg")
.test(/\.svg$/)
.use('vue')
.loader('vue-loader')
.use("vue")
.loader("vue-loader")
.end()
.use('svg-to-vue-component')
.loader('svg-to-vue-component/loader')
.use("svg-to-vue-component")
.loader("svg-to-vue-component/loader");

if (isServer) {
config.externals(nodeExternals({
Expand All @@ -30,38 +30,38 @@ module.exports = {
/instantsearch.js/,
/typeface-league-spartan/
]
}))
}));
}
},

templates: {
},
plugins: [
{
use: '@gridsome/vue-remark',
use: "@gridsome/vue-remark",
options: {
baseDir: './docs',
typeName: 'DocPage',
template: './src/templates/DocPage.vue',
route: '/:topic/:title', // e.g. /voicemail/list-and-play-voicemails/
baseDir: "./docs",
typeName: "DocPage",
template: "./src/templates/DocPage.vue",
route: "/:topic/:title", // e.g. /voicemail/list-and-play-voicemails/
plugins: [
[
'gridsome-remark-embed-snippet',
"gridsome-remark-embed-snippet",
{
directory: `${__dirname}/`
}
],
'@gridsome/remark-prismjs',
"@gridsome/remark-prismjs",
],
remark: {
autolinkHeadings: {
content: {
type: 'text',
value: '#'
type: "text",
value: "#"
}
}
}
}
},
],
}
};
85 changes: 64 additions & 21 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"@gridsome/source-filesystem": "^0.6.2",
"@gridsome/transformer-remark": "^0.6.4",
"@gridsome/vue-remark": "^0.2.4",
"axios": "^0.21.2",
"axios": "^1.6.0",
"buefy": "^0.9.13",
"node-sass": "^6.0.1",
"sass-loader": "^10.1.1",
Expand Down
1 change: 0 additions & 1 deletion src/assets/images/logo-splash.svg

This file was deleted.

Loading

0 comments on commit b38b5d0

Please sign in to comment.