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

Fix OpenAPI and Swagger URLs and CORS #802

Merged
merged 1 commit into from
Oct 4, 2023
Merged

Fix OpenAPI and Swagger URLs and CORS #802

merged 1 commit into from
Oct 4, 2023

Conversation

suricactus
Copy link
Collaborator

Since the schema endpoint has been changed, we broke the integration on https://docs.qfield.org/reference/qfieldcloud/api/ . I overlooked the endpoint renaming.

@why-not-try-calmer was there any reason you rename endpoints?

@why-not-try-calmer
Copy link
Contributor

why-not-try-calmer commented Oct 4, 2023

Since the schema endpoint has been changed, we broke the integration on https://docs.qfield.org/reference/qfieldcloud/api/ . I overlooked the endpoint renaming.

@why-not-try-calmer was there any reason you rename endpoints?

Are you talking about https://github.com/opengisch/qfieldcloud/pull/722/files#diff-53c9c2dd0d12c371d3267292e547885a0189ce67b77ec67b3f6b590f140d959a? No, no reason I would have taken seriously in light of any evidence that this was breaking something. I think this PR benefitted from discussions plus a coworking session so I don't think I was trying to be original there.

@@ -42,14 +42,19 @@
name="index",
),
path(
"schema/",
"swagger.yaml",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's not considered a good practice to use file extensions in urls, for the sake of not being hostage of an extension. But I am no expert in these conventions.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it depends. For the sake of backwards compatibility, it should have the extension for now.

@why-not-try-calmer
Copy link
Contributor

why-not-try-calmer commented Oct 4, 2023

Also I should point out that the url used in the documentation does point to a valid endpoint, any overlook notwithstanding. So isn't it simply the embedded JS being off?

@suricactus
Copy link
Collaborator Author

Also I should point out that the url used in the documentation does point to a valid endpoint, any overlook notwithstanding. So isn't it simply the embedded JS being off?

I would not prefer not to change it now.

@suricactus suricactus merged commit ef116a3 into master Oct 4, 2023
11 of 12 checks passed
@suricactus suricactus deleted the fix_openapi branch October 4, 2023 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants