From 6359cfb289a92b12f6ff453be2ca8c232cd7adf7 Mon Sep 17 00:00:00 2001 From: Matt Daily Date: Mon, 14 Jun 2021 11:12:08 -0700 Subject: [PATCH] Add shell commands to generate schema in GH workflow. Clean up TODOs on schema generation management command. --- .github/workflows/docs-gh-pages.yml | 4 ++++ make-docs.sh | 12 ------------ .../management/commands/generateschema_mocked.py | 4 ++-- 3 files changed, 6 insertions(+), 14 deletions(-) delete mode 100755 make-docs.sh diff --git a/.github/workflows/docs-gh-pages.yml b/.github/workflows/docs-gh-pages.yml index 002af64..643992c 100644 --- a/.github/workflows/docs-gh-pages.yml +++ b/.github/workflows/docs-gh-pages.yml @@ -16,6 +16,10 @@ jobs: python -m pip install --upgrade pip pip install -r requirements.txt - name: Build docs + run: | + python manage.py generateschema_mocked --file downtime.yaml + npx redoc-cli bundle downtime.yaml + mkdir docs; mv redoc-static.html docs/downtime.html run: ./make-docs.sh - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 # https://github.com/peaceiris/actions-gh-pages diff --git a/make-docs.sh b/make-docs.sh deleted file mode 100755 index 75fba4e..0000000 --- a/make-docs.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/bash -echo "Getting started" - -# Generate OpenAPI yaml file -python manage.py generateschema_mocked --file downtime.yaml - -# Bundle docs into zero-dependency HTML file -npx redoc-cli bundle downtime.yaml && \ -mkdir docs && \ -mv redoc-static.html docs/downtime.html && \ -echo "Changed name from redoc-static.html to index.html" && \ -echo -e "\nDone!" diff --git a/schedule/management/commands/generateschema_mocked.py b/schedule/management/commands/generateschema_mocked.py index 36f87fa..7f30283 100644 --- a/schedule/management/commands/generateschema_mocked.py +++ b/schedule/management/commands/generateschema_mocked.py @@ -12,8 +12,8 @@ class Command(GenerateSchemaCommand): help = "Command to generate OpenAPI schema with external services mocked" def __init__(self): super().__init__() - # Mock out ConfigDB response for doc generation. - # TODO: Need to remove all "enums" from generalized docs - we don't need OCS docs to include the contents of LCO's ConfigDB + # Mock out ConfigDB response for doc generation. + # TODO: Add mock ConfigDB dataset for docs across all projects responses._default_mock.__enter__() responses.add( responses.GET, settings.CONFIGDB_URL + '/sites/', match_querystring=True,