Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add templated-url format to the registry #3234

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ deploy/
node_modules/
scripts/
package-lock.json
.bundle/
vendor/bundle/
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
31 changes: 31 additions & 0 deletions registries/_format/templated-url.md
Original file line number Diff line number Diff line change
@@ -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
---

# <a href="..">{{ page.collection }}</a>

## {{ 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 %}