This repository was archived by the owner on Jun 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Thomas Doyle
authored and
Thomas Doyle
committed
Jan 7, 2020
1 parent
18de8a1
commit 033bdbe
Showing
30 changed files
with
3,927 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Dir for API portal deploy | ||
web_deploy | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
language: node_js | ||
node_js: | ||
- "node" | ||
deploy: | ||
- skip_cleanup: true | ||
provider: script | ||
script: npm run build && npm run gh-pages | ||
on: | ||
branch: master | ||
- skip_cleanup: true | ||
provider: script | ||
script: npm run build && npm run gh-pages -- -p "$TRAVIS_BRANCH" | ||
on: | ||
all_branches: true | ||
condition: '"$TRAVIS_BRANCH" != "master" && "$TRAVIS_BRANCH" != "gh-pages"' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2016 Ivan Goncharov | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Outfit public api v3 OpenAPI Specification | ||
[](https://travis-ci.com/Outfitio/outfit-api-v3) | ||
## Steps to finish | ||
|
||
1. Enable [Travis](https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI%3A) for your repository (**note**: you already have `.travis.yml` file) | ||
1. [Create GitHub access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/); select `public_repo` on `Select scopes` section. | ||
1. Use the token value as a value for [Travis environment variable](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings) with the name `GH_TOKEN` | ||
1. Make a test commit to trigger CI: `git commit --allow-empty -m "Test Travis CI" && git push` | ||
1. Wait until Travis build is finished. You can check progress by clicking on the `Build Status` badge at the top | ||
1. **[Optional]** You can setup [custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/) (just create `web/CNAME` file) | ||
1. **[Optional]** If your API is public consider adding it into [APIs.guru](https://APIs.guru) directory using [this form](https://apis.guru/add-api/). | ||
1. Delete this section ❌ | ||
|
||
## Links | ||
|
||
- [Reference Documentation (ReDoc)](https://outfitio.github.io/outfit-api-v3/) | ||
- [SwaggerUI](https://outfitio.github.io/outfit-api-v3/swagger-ui/) | ||
- OpenAPI Raw Files: [JSON](https://outfitio.github.io/outfit-api-v3/openapi.json) [YAML](https://outfitio.github.io/outfit-api-v3/openapi.yaml) | ||
|
||
**Warning:** All above links are updated only after Travis CI finishes deployment | ||
|
||
## Working on specification | ||
### Install | ||
|
||
1. Install [Node JS](https://nodejs.org/) | ||
2. Clone repo and run `npm install` in the repo root | ||
|
||
### Usage | ||
|
||
#### `npm start` | ||
Starts the development server. | ||
|
||
#### `npm run build` | ||
Bundles the spec and prepares web_deploy folder with static assets. | ||
|
||
#### `npm test` | ||
Validates the spec. | ||
|
||
#### `npm run gh-pages` | ||
Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured. |
Oops, something went wrong.