Validator doesn't work with custom server url
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
Research direction
Start in handlers.py at the referenced line and reproduce the failure with the provided OpenAPI YAML, using the custom production server and /test endpoint. Trace how the validator resolves server URLs and verify that an appropriate default is used when the provided URL cannot be resolved; done means the endpoint validates without requiring a visible validation server entry.
Written by the indexing model from the issue text.
Description
We are running a pyramid app with the following open api yaml definition :
openapi: 3.0.1
info:
title: Sample API
contact:
name: API Support
email: some.private@email.com
version: 1.0.0
x-audience: external-public
description: |
# Minimum
servers:
- url: https://client.public.api.com/
description: Production Server
paths:
/test:
get:
summary: "test path"
operationId: my.app.function
responses:
200:
description: will always return ok
Requests to the endpoint /test will fail with Server not found for http://0.0.0.0:8080/test unless the default server is added to the servers object:
servers:
- url: https://some.private.api.com/
description: Production Server
- url: /
description: Validation URL
it seems the url validator try to resolve the url in the servers field.
https://github.com/p1c2u/openapi-spec-validator/blob/master/openapi_spec_validator/handlers.py#L25
The validator should use the default server url as a fallback if the provided url can't be resolved.
I would like to avoid displaying the Validation URL to the api user.
note : first version incorrectly assumed a query was made on the url.
- Dominant language
- Python
- Stars
- 409
- Forks
- 73
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from python-openapi/openapi-spec-validator
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
python-openapi/openapi-spec-validator#400 · 1 comment ·
-
kind/bug/confirmed
Difficulty 5/5 Over a week Newbie friendliness 25/100
python-openapi/openapi-spec-validator#373 · 1 comment ·
All issues in python-openapi/openapi-spec-validator
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·