Skip to content
This repository has been archived by the owner on Feb 25, 2022. It is now read-only.

Consistently name schema YAML file as schema.yml #678

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ $ pip3 install apistar

Let's take a look at some of the functionality the toolkit provides...

We'll start by creating an OpenAPI schema, `schema.yaml`:
We'll start by creating an OpenAPI schema, `schema.yml`:

```yaml
openapi: 3.0.0
Expand All @@ -72,7 +72,7 @@ Let's also create a configuration file `apistar.yml`:

```yaml
schema:
path: schema.yaml
path: schema.yml
format: openapi
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ paths:
type: string
"""

index_html = apistar.docs(schema, schema_url='/schema.yaml', static_url='/static/')
index_html = apistar.docs(schema, schema_url='/schema.yml', static_url='/static/')
```

If you're serving the documentation dynamically, then you'll also need to make
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ $ pip3 install apistar

Let's take a look at some of the functionality the toolkit provides...

We'll start by creating an OpenAPI schema, `schema.yaml`:
We'll start by creating an OpenAPI schema, `schema.yml`:

```yaml
openapi: 3.0.0
Expand Down