diff --git a/.gitignore b/.gitignore index fec7c79e0b..31849e9deb 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ deploy/ node_modules/ scripts/ package-lock.json +.bundle/ +vendor/bundle/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d450c89763..8db67e59da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,15 +2,15 @@ ## Building the site -The registy site uses [jekyll](https://jekyllrb.com/), a Ruby based static site generator, with the Dinky theme. +The registy site uses [jekyll](https://jekyllrb.com/), a Ruby based static site generator, with the Just-the-Docs theme. ### Docker dev -You can use the following Docker command to build and serve the site: +You can use the following Docker or Podman command to build and serve the site: ```shell -docker build . -t oas-spec/latest -docker run -v $(pwd):/site -p 4000:4000 oas-spec/latest +docker build . -t oas-reg/latest +docker run -v $(pwd):/site -p 4000:4000 oas-reg/latest ``` ### Local Ruby dev diff --git a/registries/_format/templated-url.md b/registries/_format/templated-url.md new file mode 100644 index 0000000000..7a9b18b566 --- /dev/null +++ b/registries/_format/templated-url.md @@ -0,0 +1,31 @@ +--- +owner: MikeRalphson +issue: +description: A templated URL +base_type: string +layout: default +source_label: OpenAPI +source: https://spec.openapis.org/oas/v3.0.3.html#paths-object +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format is a templated URL, as distinct from a URI Template. The string may contain unescaped `{` and `}` characters, but is not a full [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Template or a `uri-reference'. + +Usage is as per the [`paths` Object](https://spec.openapis.org/oas/v3.0.3.html#paths-object) in OpenAPI 2.0/3.x. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %}