Spec Insert

A program that insert API Components generated from the OpenSearch OpenAPI Spec into markdown files

Signed-off-by: Theo Truong <[email protected]>

.github/workflows/jekyll-spec-insert.yml

@@ -0,0 +1,20 @@
+name: Lint and Test Jekyll Spec Insert
+on:
+  push:
+    paths:
+      - 'spec-insert/**'
+  pull_request:
+    paths:
+      - 'spec-insert/**'
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.3.0 }
+      - run: bundle install
+      - working-directory: spec-insert
+        run: |
+          bundle exec rubocop
+          bundle exec rspec

.github/workflows/update-api-components.yml

@@ -0,0 +1,52 @@
+name: Update API Components
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * 0" # Every Sunday at midnight GMT
+jobs:
+  update-api-components:
+    if: ${{ github.repository == 'opensearch-project/documentation-website' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+
+      - run: git config --global pull.rebase true
+
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.3.0 }
+
+      - run: bundle install
+
+      - name: Download spec and insert into documentation
+        run: bundle exec jekyll spec-insert
+
+      - name: Get current date
+        id: date
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
+
+      - name: GitHub App token
+        id: github_app_token
+        uses: tibdex/[email protected]
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ steps.github_app_token.outputs.token }}
+          commit-message: "Updated API components to reflect the latest OpenSearch API spec (${{ env.date }})"
+          title: "[AUTOCUT] Update API components to reflect the latest OpenSearch API spec (${{ env.date }})"
+          body: |
+            Update API components to reflect the latest [OpenSearch API spec](https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml).
+            Date: ${{ env.date }}
+          branch: update-api-components-${{ env.date }}
+          base: main
+          signoff: true
+          labels: autocut

DEVELOPER_GUIDE.md

@@ -0,0 +1,112 @@
+# Developer Guide
+ - [Introduction](#introduction)
+ - [Starting the Jekyll server locally](#starting-the-jekyll-server-locally)
+ - [Using spec-insert Jekyll plugin](#using-spec-insert-jekyll-plugin)
+   - [Insert Query Parameters](#insert-query-parameters)
+   - [Insert Path Parameters](#insert-path-parameters)
+   - [Insert Paths and HTTP Methods](#insert-paths-and-http-methods)
+   - [Ignored files and folders](#ignored-files-and-folders)
+   - [CI/CD](#cicd)
+
+## Introduction
+The `.md` documents in this repository are rendered into HTML pages using [Jekyll](https://jekyllrb.com/). These HTML pages are hosted on [opensearch.org](https://opensearch.org/docs/latest/).
+
+## Starting the Jekyll server locally
+You can run the Jekyll server locally to view the rendered HTML pages after making changes to the markdown files:
+- Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) 3.1.0 or later for your operating system.
+- Install the required gems by running `bundle install`.
+- Run `bundle exec jekyll serve` to start the Jekyll server locally. (This can take several minutes to be ready.)
+- Open your browser and navigate to `http://localhost:4000` to view the rendered HTML pages.
+
+## Using spec-insert Jekyll plugin
+The `spec-insert` Jekyll plugin is used to insert API components into the markdown files. The plugin downloads the latest OpenSearch Specification and renders the API components from the spec. This aims to reduce the manual effort required to keep the documentation up-to-date.
+
+To use this plugin, make sure that you have installed Ruby 3.1.0 or later and the required gems by running `bundle install`.
+
+Edit your markdown file and insert the following snippet where you want an API component to be rendered:
+```markdown
+<!-- spec_insert_start 
+api: <API_NAME>
+component: <COMPONENT_NAME>
+other_param: <OTHER_PARAM>
+-->
+
+This is where the API component will be inserted.
+Everything between the `spec_insert_start` and `spec_insert_end` tags will be overwritten.
+
+<!-- spec_insert_end -->
+```
+
+Then run the follow Jekyll command to render the API components:
+```shell
+bundle exec jekyll spec-insert
+```
+
+If you are working on multiple markdown files and do not want to keep running the `jekyll spec-insert` command, you can add the `--watch` (or `-W`) flag to the command to watch for changes in the markdown files and automatically render the API components:
+```shell
+bundle exec jekyll spec-insert --watch
+```
+
+Note that depending on the text editor you are using to edit the markdown, you may need to manually reload the file from disk to see the changes applied by the plugin if the editor does not automatically reload the file periodically.
+
+The plugin will pull the newest OpenSearch Spec from its [repository](https://github.com/opensearch-project/opensearch-api-specification) if the spec file does not exist locally or if it is older than 24 hours. To tell the plugin to always pull the newest spec, you can add the `--refresh-spec` (or `-R`) flag to the command:
+
+```shell
+bundle exec jekyll spec-insert --refresh-spec
+```
+
+### Insert Query Parameters
+To insert query parameters table of the `cat.indices` API, use the following snippet:
+```markdown
+<!-- spec_insert_start
+api: cat.indices
+component: query_parameters
+-->
+<!-- spec_insert_end -->
+```
+
+- This will insert the query parameters of the `cat.indices` API into the markdown file 3 default columns: `Parameter`, `Type`, and `Description`. There are 5 columns that can be inserted: `Parameter`, `Type`, `Description`, `Required`, and `Default`. When `Required`/`Default` is not chosen, the info will be written in the `Description` column.
+- This component accepts `include_global` (boolean, default to `false`) argument to include global query parameters in the table.
+- This component accepts `include_deprecated` (boolean, default to `true`) argument to include deprecated parameters in the table.
+- This component accepts `pretty` (boolean, default to `false`) argument to render the table in the pretty format instead of the compact format.
+
+```markdown
+<!-- spec_insert_start
+api: cat.indices
+component: query_parameters
+include_global: true
+include_deprecated: false
+pretty: true
+-->
+<!-- spec_insert_end -->
+```
+
+### Insert Path Parameters
+
+To insert path parameters table of the `indices.create` API, use the following snippet:
+```markdown
+<!-- spec_insert_start
+api: indices.create
+component: path_parameters
+-->
+<!-- spec_insert_end -->
+```
+
+This table behaves the same as the query parameters table except that it does not accept the `include_global` argument.
+
+### Insert Paths and HTTP Methods
+
+To insert paths and HTTP methods of the `search` API, use the following snippet:
+```markdown
+<!-- spec_insert_start
+api: search
+component: paths_and_http_methods
+-->
+<!-- spec_insert_end -->
+```
+
+### Ignored files and folders
+The `spec-insert` plugin ignores all files and folders listed in the [./_config.yml#exclude](./_config.yml) list, which is also the list of files and folders that Jekyll ignores.
+
+### CI/CD
+The `spec-insert` plugin is run as part of the CI/CD pipeline to ensure that the API components are up-to-date in the documentation. This is done through the [update-api-components.yml](.github/workflows/update-api-components.yml) Github Action workflow that creates a pull request with the updated API components every Monday.

Gemfile

@@ -1,4 +1,9 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Manually add csv gem since Ruby 3.4.0 no longer includes it
+gem 'csv', '~> 3.0'
 
 # Hello! This is where you manage which Jekyll version is used to run.
 # When you want to use a different version, change it below, save the
@@ -8,12 +13,12 @@ source "http://rubygems.org"
 #
 # This will help ensure the proper Jekyll version is running.
 # Happy Jekylling!
-gem "jekyll", "~> 4.3.2"
+gem 'jekyll', '~> 4.3.2'
 
 # This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem "just-the-docs", "~> 0.3.3"
-gem "jekyll-remote-theme", "~> 0.4"
-gem "jekyll-redirect-from", "~> 0.16"
+gem 'jekyll-redirect-from', '~> 0.16'
+gem 'jekyll-remote-theme', '~> 0.4'
+gem 'just-the-docs', '~> 0.3.3'
 
 # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
 # uncomment the line below. To upgrade, run `bundle update github-pages`.
@@ -22,21 +27,31 @@ gem "jekyll-redirect-from", "~> 0.16"
 
 # If you have any plugins, put them here!
 group :jekyll_plugins do
-  gem "jekyll-last-modified-at"
-  gem "jekyll-sitemap"
+  gem 'jekyll-last-modified-at'
+  gem 'jekyll-sitemap'
+  gem 'jekyll-spec-insert', :path => './spec-insert'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
 
 # Performance-booster for watching directories on Windows
-gem "wdm", "~> 0.1.0" if Gem.win_platform?
+gem 'wdm', '~> 0.1.0' if Gem.win_platform?
 
 # Installs webrick dependency for building locally
-gem "webrick", "~> 1.7"
-
+gem 'webrick', '~> 1.7'
 
 # Link checker
-gem "typhoeus"
-gem "ruby-link-checker"
-gem "ruby-enum"
+gem 'ruby-enum'
+gem 'ruby-link-checker'
+gem 'typhoeus'
+
+# Spec Insert
+gem 'activesupport', '~> 7'
+gem 'mustache', '~> 1'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rubocop', '~> 1.44', require: false
+  gem 'rubocop-rake', require: false
+end

README.md

@@ -3,6 +3,7 @@
 # About the OpenSearch documentation repo
 
 The `documentation-website` repository contains the user documentation for OpenSearch. You can find the rendered documentation at [opensearch.org/docs](https://opensearch.org/docs).
+The markdown files in this repository are rendered into HTML pages using [Jekyll](https://jekyllrb.com/). Check the [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md) for more information on how to use Jekyll for this repository.
 
 
 ## Contributing

_config.yml

@@ -311,6 +311,7 @@ plugins:
   - jekyll-remote-theme
   - jekyll-redirect-from
   - jekyll-sitemap
+  - jekyll-spec-insert
 
 # This format has to conform to RFC822
 last-modified-at:
@@ -320,13 +321,21 @@ last-modified-at:
 # The following items will not be processed, by default. Create a custom list
 # to override the default setting.
 exclude:
+  - README.md
+  - DEVELOPER_GUIDE.md
   - Gemfile
   - Gemfile.lock
   - node_modules
   - vendor/bundle/
   - vendor/cache/
   - vendor/gems/
   - vendor/ruby/
-  - README.md
-  - .idea
-  - templates
+  - templates/
+  - .sass-cache/
+  - .jekyll-cache/
+  - .idea/
+  - .github/
+  - .bundle/
+  - _site/
+  - spec-insert
+  - release-notes

spec-insert/.gitignore

@@ -0,0 +1,2 @@
+opensearch-openapi.yaml
+rspec_examples.txt

spec-insert/.rspec

@@ -0,0 +1 @@
+--require spec_helper

spec-insert/.rubocop.yml

@@ -0,0 +1,29 @@
+require: rubocop-rake
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'Rakefile'
+  NewCops: enable
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+Style/SingleLineMethods:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/jekyll-spec-insert.rb' # For Jekyll to recognize the plugin

spec-insert/jekyll-spec-insert.gemspec

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-spec-insert'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Theo Truong']
+  spec.email         = ['[email protected]']
+
+  spec.summary       = 'A Jekyll plugin for inserting OpenSearch OpenAPI specifications into Jekyll sites'
+
+  spec.files         = Dir['lib/**/*.rb']
+  spec.require_paths = ['lib']
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.required_ruby_version = '>= 3.1.0'
+end