Update docs with base_uri examples

python-openapi · Jul 9, 2023 · 99e9887 · 99e9887
1 parent db40da1
commit 99e9887
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.rst b/README.rst
@@ -88,7 +88,7 @@ Python package
     from openapi_spec_validator import validate_spec
     from openapi_spec_validator.readers import read_from_filename
 
-    spec_dict, spec_url = read_from_filename('openapi.yaml')
+    spec_dict, base_uri = read_from_filename('openapi.yaml')
 
     # If no exception is raised by validate_spec(), the spec is valid.
     validate_spec(spec_dict)

diff --git a/docs/index.rst b/docs/index.rst
@@ -78,7 +78,7 @@ Usage
          from openapi_spec_validator import validate_spec
          from openapi_spec_validator.readers import read_from_filename
 
-         spec_dict, spec_url = read_from_filename('openapi.yaml')
+         spec_dict, base_uri = read_from_filename('openapi.yaml')
 
          # If no exception is raised by validate_spec(), the spec is valid.
          validate_spec(spec_dict)

diff --git a/docs/python.rst b/docs/python.rst
@@ -8,7 +8,7 @@ By default, OpenAPI spec version is detected. To validate spec:
     from openapi_spec_validator import validate_spec
     from openapi_spec_validator.readers import read_from_filename
 
-    spec_dict, spec_url = read_from_filename('openapi.yaml')
+    spec_dict, base_uri = read_from_filename('openapi.yaml')
 
     # If no exception is raised by validate_spec(), the spec is valid.
     validate_spec(spec_dict)
@@ -19,11 +19,11 @@ By default, OpenAPI spec version is detected. To validate spec:
     ...
     OpenAPIValidationError: 'info' is a required property
          
-Add ``spec_url`` to validate spec with relative files:
+Add ``base_uri`` to validate spec with relative files:
 
 .. code:: python
 
-    validate_spec(spec_dict, spec_url='file:///path/to/spec/openapi.yaml')
+    validate_spec(spec_dict, base_uri='file:///path/to/spec/openapi.yaml')
 
 You can also validate spec from url: