Skip to content

Commit

Permalink
Switched to OpenAPI 3.0 and Redoc
Browse files Browse the repository at this point in the history
For the 1 year anniversary of issue #39, this is a new design of the website with more details and docs on authentication.
  • Loading branch information
rithvikvibhu committed Jun 28, 2020
1 parent 878d6b2 commit 96ffcc5
Show file tree
Hide file tree
Showing 13 changed files with 7,869 additions and 6,826 deletions.
7 changes: 2 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
*.html
raw.txt

node_modules
dist
node_modules/
dist/
28 changes: 14 additions & 14 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
language: node_js
node_js:
- "8"
- '12'

install:
- npm install
- npm install

script:
- mkdir dist
- npm run dist
- sed -i dist/index.html -f gatracking.sed
- mkdir dist
- npm run build
- sed -i dist/index.html -f gatracking.sed

deploy:
provider: pages
skip_cleanup: true
github_token: $GH_TOKEN
local_dir: dist/
on:
branch: master
provider: pages
skip_cleanup: true
github_token: $GH_TOKEN
local_dir: dist/
on:
branch: master

branches:
only:
- master
- master
5,420 changes: 5,420 additions & 0 deletions GoogleHome.openapi3.json

Large diffs are not rendered by default.

2,645 changes: 0 additions & 2,645 deletions GoogleHome.postman_collection.json

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

The MIT License (MIT)

Copyright (c) 2018
Copyright (c) 2020 Rithvik Vibhu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
# [Google Home Local API Documentation](https://rithvikvibhu.github.io/GHLocalApi/)

**Updated on: 2018-09-30**
**Updated on: 2020-06-28**
Available here: https://rithvikvibhu.github.io/GHLocalApi/

[![Build Status](https://travis-ci.org/rithvikvibhu/GHLocalApi.svg?branch=master)](https://travis-ci.org/rithvikvibhu/GHLocalApi)
[![GitHub stars](https://img.shields.io/github/stars/rithvikvibhu/GHLocalApi)](https://github.com/rithvikvibhu/GHLocalApi/stargazers) [![GitHub license](https://img.shields.io/github/license/rithvikvibhu/GHLocalApi)](https://github.com/rithvikvibhu/GHLocalApi/blob/master/LICENSE.md) [![Build Status](https://travis-ci.org/rithvikvibhu/GHLocalApi.svg?branch=master)](https://travis-ci.org/rithvikvibhu/GHLocalApi)

Documentation for Google Home's local API, written in [API Blueprint](https://apiblueprint.org/) and rendered with [danielgtaylor/aglio](https://github.com/danielgtaylor/aglio).
Documentation for Google Home's local API, specs in [OpenAPI 3.0](https://swagger.io/specification/). Rendered with [Redoc](https://github.com/Redocly/redoc).

The API Blueprint is in `all.apib`.
Travis CI generates the static website with Redoc.

A postman collection (v2.1) is also available for import (`GoogleHome.postman_collection.json`). Set a Global or Environment variable called `url` with the IP address of the device and port 8008. Example: `http://192.168.1.15:8008`
- `npm run build` generates the static site in the 'dist' folder (Make sure the folder exists).
- `npm run serve` serves the page with a web server.

## Contributing

* This project is created in [Postman](https://www.getpostman.com/) and exported to [API Blueprint format](https://apiblueprint.org/) using [APIMATIC's Transformer API](https://apimatic.io/transformer).
* This project makes use of [aglio](https://github.com/danielgtaylor/aglio), which is an API Blueprint renderer. Here are the [instructions](https://github.com/danielgtaylor/aglio#installation--usage) to getting aglio set up.
* Travis-ci generates the static website with aglio.
* `npm run dist` generates the static site in the 'dist' folder (Make sure the folder exists).
The Open API spec is exported from Apimatic. Instead of submitting pull requests with changes to this file, please create an issue with the changes instead.
1,695 changes: 0 additions & 1,695 deletions all.apib

This file was deleted.

13 changes: 0 additions & 13 deletions apib2html.js

This file was deleted.

44 changes: 0 additions & 44 deletions endpoints-list.md

This file was deleted.

23 changes: 0 additions & 23 deletions multizone.apib

This file was deleted.

Loading

0 comments on commit 96ffcc5

Please sign in to comment.