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

Change default format from jsonv2 to geocodejson #10

Merged
merged 19 commits into from
Nov 6, 2023

Conversation

jenkin
Copy link
Collaborator

@jenkin jenkin commented Oct 2, 2023

Define GeocodeJSON json schema for both search and lookup endpoints and clean now useless schemas.

Add automatic validation, dereferencing and minification tools.

Refs: #2

Define GeocodeJSON json schema for both `search` and `lookup` endpoints and clean now useless schemas.

Refs: #2
@jenkin jenkin added the enhancement New feature or request label Oct 2, 2023
@jenkin jenkin self-assigned this Oct 2, 2023
@jenkin jenkin linked an issue Oct 2, 2023 that may be closed by this pull request
Reference GeoJSON schema to define the GeocodeJSON one. Put it in a standalone file and reference it inside the OpenAPI spec.

Refs: #2
Add `make validate` utility using `@apidevtools/swagger-cli` to validate OpenAPI spec.

Add `make bundle` utility to dereference and minify OpenAPI spec and JSON schema.

New dependency: `npx`.

Refs: #2
Now checksums are computed (pre-commit) and checked (pre-push) for both OpenAPI spec and JSON schema and their minified versions.

Refs: #2
Swagger UI now loads the minified OpenAPI spec.

Swagger Editor (latest version) doesn't support custom spec passed with envars or url parameters (see [swagger-editor/issues/4411](swagger-api/swagger-editor#4411)).

Refs: #2
@jenkin jenkin changed the title feat: change default format from jsonv2 to geocodejson Change default format from jsonv2 to geocodejson Oct 3, 2023
@jenkin jenkin marked this pull request as ready for review October 4, 2023 15:08
@jenkin
Copy link
Collaborator Author

jenkin commented Oct 10, 2023

This work is leading to define and publish JSON schemas for three formats: geocodejson, semver and geohash.

For geocodejson I opened an issue and forked the official repo ready for a PR.

For semver I opened an issue on the official website repo.

For geohash I sent an email to the official contant point.

@jenkin
Copy link
Collaborator Author

jenkin commented Nov 6, 2023

We are waiting for geocoders/geocodejson-spec#25 but all schema dependencies are now published by https://github.com/jenkin/json-schema-bricks. So I'll merge this PR for now.

@jenkin jenkin merged commit f36b926 into main Nov 6, 2023
@jenkin jenkin deleted the feature/2_from-jsonv2-to-geocodejson branch November 6, 2023 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change default format from jsonv2 to geocodejson for /search endpoint
1 participant