Skip to content

Latest commit

 

History

History
62 lines (52 loc) · 4.09 KB

README.md

File metadata and controls

62 lines (52 loc) · 4.09 KB
Raw

DataHub OpenAPI Specification

Build Status

Steps to update the documentation (needs to be done for skylight-api and datahub-api repos)

  1. The spec/swagger.yaml will need to be updated with the latest Gather swagger.yaml. To do this, go to the Gather master branch in adh-gather repo, and replace the ##### GATHER PATHS ##### and ##### GATHER DEFINITIONS ##### portion with the latest one.
  2. After this, go to the Accedian/stitchIt repo, and from the master branch get the latest openapi.yaml. Run the command: brew install npm npx @redocly/cli build-docs openapi.yaml
    This will generate a static html file. Edit the HTML file, if needed, to have the latest Release Date. For example, replace all instances of 23.08 with 23.11 - this is only necessary if the openapi.yaml has not had any updates since the last release. Rename this file to session-stitchIt.html and replace the existing HTML file in the skylight-api/web/ and datahub-api/web/ folder.
  3. Go to Accedian/sensor-orchestrate repo https://github.com/Accedian/sensor-orchestrate/blob/master/_resources/static/docs.html (copy and paste all into /web/agent-orchestration.html).
  4. For Capture-Orchestration, please go to https://console.cloud.google.com/storage/browser/pykouze-openapi and download the HTML for the specific release date. Rename this file to capture-orchestration.html and place it in the web folder.
  5. Once this is done, create the PR.

Steps to finish

  1. Enable Travis for your repository (note: you already have .travis.yml file)
  2. Create GitHub access token; check public_repo on Select scopes section.
  3. Use the token value as a value for Travis environment variable with the name GH_TOKEN
  4. Make a test commit to trigger CI: git commit --allow-empty -m "Test Travis CI" && git push
  5. Wait until Travis build is finished. You can check progress by clicking on the Build Status badge at the top
  6. If you did everything correct, https://accedian.github.io/datahub-api/ will lead to your new docs
  7. [Optional] You can setup custom domain (just create web/CNAME file)
  8. Start writing/editing your OpenAPI spec: check out usage section below
  9. [Optional] If you document public API consider adding it into APIs.guru directory using this form.
  10. Delete this section 😄

Links

Warning: All above links are updated only after Travis CI finishes deployment

Working on specification

Install

  1. Install Node JS
  2. Clone repo and cd
    • Run npm install

Usage

  1. Run npm start
  2. Checkout console output to see where local server is started. You can use all links (except preview) by replacing https://accedian.github.io/datahub-api/ with url from the message: Server started <url>
  3. Make changes using your favorite editor or swagger-editor (look for URL in console output)
  4. All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change TIP: you can open swagger-editor, documentation and swagger-ui in parallel
  5. Once you finish with the changes you can run tests using: npm test
  6. Share you changes with the rest of the world by pushing to GitHub :smile