Skip to content

Commit 99e9887

Browse files
committed
Update docs with base_uri examples
1 parent db40da1 commit 99e9887

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Python package
8888
from openapi_spec_validator import validate_spec
8989
from openapi_spec_validator.readers import read_from_filename
9090
91-
spec_dict, spec_url = read_from_filename('openapi.yaml')
91+
spec_dict, base_uri = read_from_filename('openapi.yaml')
9292
9393
# If no exception is raised by validate_spec(), the spec is valid.
9494
validate_spec(spec_dict)

docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Usage
7878
from openapi_spec_validator import validate_spec
7979
from openapi_spec_validator.readers import read_from_filename
8080
81-
spec_dict, spec_url = read_from_filename('openapi.yaml')
81+
spec_dict, base_uri = read_from_filename('openapi.yaml')
8282
8383
# If no exception is raised by validate_spec(), the spec is valid.
8484
validate_spec(spec_dict)

docs/python.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ By default, OpenAPI spec version is detected. To validate spec:
88
from openapi_spec_validator import validate_spec
99
from openapi_spec_validator.readers import read_from_filename
1010
11-
spec_dict, spec_url = read_from_filename('openapi.yaml')
11+
spec_dict, base_uri = read_from_filename('openapi.yaml')
1212
1313
# If no exception is raised by validate_spec(), the spec is valid.
1414
validate_spec(spec_dict)
@@ -19,11 +19,11 @@ By default, OpenAPI spec version is detected. To validate spec:
1919
...
2020
OpenAPIValidationError: 'info' is a required property
2121
22-
Add ``spec_url`` to validate spec with relative files:
22+
Add ``base_uri`` to validate spec with relative files:
2323

2424
.. code:: python
2525
26-
validate_spec(spec_dict, spec_url='file:///path/to/spec/openapi.yaml')
26+
validate_spec(spec_dict, base_uri='file:///path/to/spec/openapi.yaml')
2727
2828
You can also validate spec from url:
2929

0 commit comments

Comments
 (0)