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

3 create swagger api specification for mobility database #4

Merged

Conversation

jcpitre
Copy link
Contributor

@jcpitre jcpitre commented Jun 12, 2023

Added the swagger for the mobility database and some code to be able to display it in a Github page.

@jcpitre jcpitre linked an issue Jun 12, 2023 that may be closed by this pull request
@jcpitre jcpitre requested a review from davidgamez June 12, 2023 20:14
@jcpitre jcpitre temporarily deployed to github-pages June 12, 2023 20:51 — with GitHub Pages Inactive
@CLAassistant
Copy link

CLAassistant commented Jun 12, 2023

CLA assistant check
All committers have signed the CLA.

@jcpitre jcpitre temporarily deployed to github-pages June 14, 2023 03:31 — with GitHub Pages Inactive
@jcpitre jcpitre temporarily deployed to github-pages June 14, 2023 03:47 — with GitHub Pages Inactive
@jcpitre jcpitre temporarily deployed to github-pages June 21, 2023 04:09 — with GitHub Pages Inactive
@jcpitre jcpitre temporarily deployed to github-pages June 21, 2023 04:11 — with GitHub Pages Inactive
@jcpitre jcpitre temporarily deployed to github-pages June 21, 2023 04:15 — with GitHub Pages Inactive
docs/DatabaseCatalogAPI.yaml Outdated Show resolved Hide resolved
docs/DatabaseCatalogAPI.yaml Outdated Show resolved Hide resolved
Comment on lines 414 to 426
schema:
type: string
enum:
- completely_enclosed
- partially_enclosed
- disjoint
description: >
Specify the filtering method to use with the boundingLatitudes and boundingLongitudes parameters.
* `completely_enclosed` - Get resources that are completely enclosed in the specified bounding box.
* `partially_enclosed` - Get resources that are partially enclosed in the specified bounding box.
* `disjoint` - Get resources that are completely outside the specified bounding box.
example: completely_enclosed
default: completely_enclosed
Copy link
Member

Choose a reason for hiding this comment

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

The default property is part of the schema properties

Suggested change
schema:
type: string
enum:
- completely_enclosed
- partially_enclosed
- disjoint
description: >
Specify the filtering method to use with the boundingLatitudes and boundingLongitudes parameters.
* `completely_enclosed` - Get resources that are completely enclosed in the specified bounding box.
* `partially_enclosed` - Get resources that are partially enclosed in the specified bounding box.
* `disjoint` - Get resources that are completely outside the specified bounding box.
example: completely_enclosed
default: completely_enclosed
schema:
type: string
enum:
- completely_enclosed
- partially_enclosed
- disjoint
default: completely_enclosed
description: >
Specify the filtering method to use with the boundingLatitudes and boundingLongitudes parameters.
* `completely_enclosed` - Get resources that are completely enclosed in the specified bounding box.
* `partially_enclosed` - Get resources that are partially enclosed in the specified bounding box.
* `disjoint` - Get resources that are completely outside the specified bounding box.
example: completely_enclosed
  • As I typed the suggestion on Github, the indentation might not be correct

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

docs/DatabaseCatalogAPI.yaml Outdated Show resolved Hide resolved
docs/DatabaseCatalogAPI.yaml Outdated Show resolved Hide resolved
docs/DatabaseCatalogAPI.yaml Outdated Show resolved Hide resolved
docs/DatabaseCatalogAPI.yaml Outdated Show resolved Hide resolved
docs/DatabaseCatalogAPI.yaml Show resolved Hide resolved
docs/DatabaseCatalogAPI.yaml Show resolved Hide resolved
docs/DatabaseCatalogAPI.yaml Show resolved Hide resolved
@jcpitre jcpitre temporarily deployed to github-pages June 23, 2023 17:11 — with GitHub Pages Inactive
@jcpitre jcpitre temporarily deployed to github-pages June 26, 2023 04:36 — with GitHub Pages Inactive
Copy link
Member

@davidgamez davidgamez left a comment

Choose a reason for hiding this comment

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

🚀

@davidgamez davidgamez merged commit 01df3a8 into main Jun 27, 2023
@davidgamez davidgamez deleted the 3-create-swagger-api-specification-for-mobility-database branch June 27, 2023 20:47
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.

Create Swagger API specification for Mobility Database
4 participants