From b9dbef8a37ad2da34ab8dab91ab9832dcdf49a96 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Thu, 2 Feb 2023 12:12:11 +0000 Subject: [PATCH] Remove cask-source and versions APIs These are no longer needed after https://github.com/Homebrew/brew/pull/14439 and https://github.com/Homebrew/brew/pull/14500 are merged and in a stable tag. --- _includes/api-samples/versions_casks.md | 23 --------------- _includes/api-samples/versions_formulae.md | 15 ---------- docs/api.md | 33 ---------------------- script/generate-api-samples.rb | 15 ---------- script/generate-cask.rb | 3 +- 5 files changed, 1 insertion(+), 88 deletions(-) delete mode 100644 _includes/api-samples/versions_casks.md delete mode 100644 _includes/api-samples/versions_formulae.md diff --git a/_includes/api-samples/versions_casks.md b/_includes/api-samples/versions_casks.md deleted file mode 100644 index bd49c5d2018..00000000000 --- a/_includes/api-samples/versions_casks.md +++ /dev/null @@ -1,23 +0,0 @@ -```json -{ - ... - "docker": { - "version": "4.16.1,95567", - "versions": {} - }, - ... - "onyx": { - "version": "4.2.7", - "versions": { - "ventura": "4.3.5", - "big_sur": "4.0.2", - "catalina": "3.8.7", - "mojave": "3.6.8", - "high_sierra": "3.4.9", - "sierra": "3.3.1", - "el_capitan": "3.1.9" - } - }, - ... -} -``` \ No newline at end of file diff --git a/_includes/api-samples/versions_formulae.md b/_includes/api-samples/versions_formulae.md deleted file mode 100644 index bc073d22aba..00000000000 --- a/_includes/api-samples/versions_formulae.md +++ /dev/null @@ -1,15 +0,0 @@ -```json -{ - ... - "wget": { - "version": "1.21.3", - "revision": 1 - }, - ... - "zsh": { - "version": "5.9", - "revision": 0 - }, - ... -} -``` \ No newline at end of file diff --git a/docs/api.md b/docs/api.md index 14f280696e4..9e6f2bf295f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -22,23 +22,6 @@ GET https://formulae.brew.sh/api/cask.json {% include api-samples/formula.md %} -### List the latest versions for all {{ site.taps.core.name }} formulae or {{ site.taps.cask.name }} casks - -List the latest version information for each formula or cask in the given tap. The result is a single JSON object with formula/cask names as keys. The values are JSON objects containing `version` and, for formulae, `revision` keys. - -``` -GET https://formulae.brew.sh/api/versions-formulae.json -GET https://formulae.brew.sh/api/versions-casks.json -``` - -#### [Formulae Response](https://formulae.brew.sh/api/versions-formulae.json) - -{% include api-samples/versions_formulae.md %} - -#### [Casks Response](https://formulae.brew.sh/api/versions-casks.json) - -{% include api-samples/versions_casks.md %} - ### Get formula metadata for a {{ site.taps.core.name }} formula Get the `brew info --json --formula ` output for a single, current {{ site.taps.core.fullname }} formula with extra keys containing analytics data and generation date. @@ -87,22 +70,6 @@ GET https://formulae.brew.sh/api/cask/${FORMULA}.json {% include api-samples/cask_docker.md %} -### Get the source code for a cask in {{ site.taps.cask.fullname }} - -Get the latest source code for a cask that is defined in the {{ site.taps.cask.fullname }} repo. - -``` -GET https://formulae.brew.sh/api/cask-source/${FORMULA}.rb -``` - -#### Variables - -- `${FORMULA}`: the name of the cask, e.g. `vagrant` - -#### [Response](https://formulae.brew.sh/api/cask-source/vagrant.json) - -{% include api-samples/cask_source_vagrant.md %} - ## Analytics ### List one category of analytics events diff --git a/script/generate-api-samples.rb b/script/generate-api-samples.rb index ae20387e7b8..d35bef7cd77 100755 --- a/script/generate-api-samples.rb +++ b/script/generate-api-samples.rb @@ -6,11 +6,8 @@ analytics_install_homebrew_core_30d: "analytics/install/homebrew-core/30d.json", bottle_wget: "bottle/wget.json", cask_docker: "cask/docker.json", - cask_source_vagrant: "cask-source/vagrant.rb", formula_wget: "formula/wget.json", formula: "formula.json", - versions_casks: "versions-casks.json", - versions_formulae: "versions-formulae.json", }.freeze def generate_api_samples @@ -62,14 +59,6 @@ def format_json_contents(name, api_url) contents.select! do |obj| obj["name"] == "wget" end - when :versions_casks - contents.select! do |cask_token, _| - %w[docker onyx].include? cask_token - end - when :versions_formulae - contents.select! do |formula_name, _| - %w[wget zsh].include? formula_name - end end contents = JSON.pretty_generate contents @@ -94,10 +83,6 @@ def format_json_contents(name, api_url) when :formula contents.sub!(/^\[/, "[\n ...") contents.sub!(/}(?=\n\])/, "},\n ...") - when :versions_casks, :versions_formulae - contents.sub!(/^{/, "{\n ...") - contents.sub!(/( },)(?=\n ")/, "\\1\n ...") - contents.sub!(/}(?=\n})/, "},\n ...") end codify contents, language: "json" diff --git a/script/generate-cask.rb b/script/generate-cask.rb index 8b4ffbd2859..d598c9b67d9 100755 --- a/script/generate-cask.rb +++ b/script/generate-cask.rb @@ -4,7 +4,7 @@ tap_name = ARGV.first tap = Tap.fetch(tap_name) -directories = ["_data/cask", "api/cask", "api/cask-source", "cask"] +directories = ["_data/cask", "api/cask", "cask"] FileUtils.rm_rf directories FileUtils.mkdir_p directories @@ -15,6 +15,5 @@ c = Cask::CaskLoader.load(p) IO.write("_data/cask/#{c.token}.json", "#{JSON.pretty_generate(c.to_hash_with_variations)}\n") IO.write("api/cask/#{c.token}.json", json_template) - IO.write("api/cask-source/#{c.token}.rb", p.read) IO.write("cask/#{c.token}.html", html_template.gsub("title: $TITLE", "title: \"#{c.token}\"")) end