Added a DocC catalog coverage check.
This commit is contained in:
1 parent
2cfacd0e14
commit
ff00fdd852
9 files changed
+134
-42
No files matched your search
@@ -82,6 +82,9 @@ doc-generate-github: ## Generates the library documentation for Github
|
||||
--hosting-base-path $(DOCC_GITHUB_BASE_PATH) \
|
||||
--output-path $(DOCC_GITHUB_OUTPUT)
|
||||
|
||||
doc-check: ## Checks the DocC catalog covers every generated operation and schema
|
||||
@python3 -I Scripts/check-docc.py "$(OAS_GENERATE_OUTPUT)" "$(DOCC_CATALOG)"
|
||||
|
||||
doc-preview: ## Previews the library documentation in Safari
|
||||
@open -a safari $(DOCC_PREVIEW_URL)
|
||||
@ENABLE_DOCC_PLUGIN=1 swift package \
|
||||
@@ -101,13 +104,16 @@ oas-download: ## Downloads the latest App Store Connect OpenAPI specification do
|
||||
@unzip -q "$(OAS_DOWNLOAD_INPUT)" -d "$(OAS_DOWNLOAD_FOLDER)"
|
||||
@mv "$(OAS_DOWNLOAD_FILE)" "$(OAS_DOWNLOAD_OUTPUT)"
|
||||
@rm -rf "$(OAS_DOWNLOAD_FOLDER)"
|
||||
@$(MAKE) --no-print-directory oas-patch
|
||||
@# Generating the code also validates the document.
|
||||
@$(MAKE) --no-print-directory oas-patch-document
|
||||
@$(MAKE) --no-print-directory oas-generate
|
||||
@$(MAKE) --no-print-directory doc-check
|
||||
|
||||
oas-patch: # Patches the OpenAPI specification document with the patches in Scripts/patch-oas.jq
|
||||
oas-patch: oas-patch-document oas-validate # Patches and validates the OpenAPI specification document
|
||||
|
||||
oas-patch-document: # Patches the OpenAPI specification document with Scripts/patch-oas.jq
|
||||
@jq --from-file Scripts/patch-oas.jq "$(OAS_DOWNLOAD_OUTPUT)" > "$(OAS_DOWNLOAD_OUTPUT).tmp"
|
||||
@mv "$(OAS_DOWNLOAD_OUTPUT).tmp" "$(OAS_DOWNLOAD_OUTPUT)"
|
||||
@$(MAKE) --no-print-directory oas-validate
|
||||
|
||||
oas-validate: ## Validates the OpenAPI specification document
|
||||
@swift run \
|
||||
|
||||
Reference in new issue
Block a user