Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI spec remove dev server #1496

Open
bwbroersma opened this issue Sep 12, 2024 · 0 comments
Open

OpenAPI spec remove dev server #1496

bwbroersma opened this issue Sep 12, 2024 · 0 comments
Assignees

Comments

@bwbroersma
Copy link
Collaborator

bwbroersma commented Sep 12, 2024

Currently the dev server is exposed in the openapi.yml, while this is inaccessible due to authentication.

SERVERS = [
{"url": "https://batch.internet.nl/api/batch/v2", "description": "Production server"},
{
"url": "https://dev.batch.internet.nl/api/batch/v2",
"description": "Development server (data longevity is not guaranteed)",
},
]

It also seems that these URI's are static, and don't use the env variables:

DESC_INTRO_REDOCLY_LINK = "https://batch.internet.nl/api/batch/openapi.yaml"

Probably change both (remove dev / only expose the instance and use env for this).

Update: maybe remove the schema and hostname altogether in the server part? Since that seems valid, only concern is that the YAML cannot be used to determine the server outside of the hostname.

Maybe also fix the branding:

TITLE = "Internet.nl Batch API"
TERMS = ""
CONTACT = {"name": "Internet.nl Help desk", "email": "[email protected]"}
LOGO = {
"url": "https://batch.internet.nl/static/logo_en.svg",
"backgroundColor": "#FAFAFA",
"altText": "Internet.nl logo",
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants