From 761f9470dafdf4ba5cce272ec6f85ab4b02d32f3 Mon Sep 17 00:00:00 2001 From: omussell Date: Thu, 2 Jul 2020 19:50:09 +0100 Subject: [PATCH] Consistently name schema YAML file as schema.yml --- README.md | 4 ++-- docs/api-documentation.md | 2 +- docs/index.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 05b060a4..2b7ed74b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -72,7 +72,7 @@ Let's also create a configuration file `apistar.yml`: ```yaml schema: - path: schema.yaml + path: schema.yml format: openapi ``` diff --git a/docs/api-documentation.md b/docs/api-documentation.md index a375d43e..34f1ed9c 100644 --- a/docs/api-documentation.md +++ b/docs/api-documentation.md @@ -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 diff --git a/docs/index.md b/docs/index.md index b1e1e0c8..4962984f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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