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

update CQL2 definition to reference OGC API yaml file in github, update npm build #261

Merged
merged 2 commits into from
Mar 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
validate:
working_directory: ~/stac
docker:
- image: cimg/node:14.7
- image: cimg/node:16
steps:
- checkout
- save_cache:
Expand Down
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
**Related Issue(s):** #
**Related Issue(s):**

- #

**Proposed Changes:**

Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ build/Release
# Dependency directories
node_modules/
jspm_packages/
package-lock.json
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

recommended practice is to commit package-lock.json

Copy link
Collaborator

Choose a reason for hiding this comment

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

For software yes, but for a specification? There I'd assume you'd want the latest version?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think for any build where you have dependencies. They're pinned to specific versions in it. Otherwise, anytime new build dependency versions could be resolved that no longer work with the current code, and there's no easy way to fix that, since you don't know what previous versions actually worked.


# Typescript v1 declaration files
typings/
Expand Down
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
16
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

use nvmrc, and upgrade to node 16

Copy link
Collaborator

Choose a reason for hiding this comment

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

What's the reasoning? And why in a CQL PR?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I was updating the openapi yaml, so I took the opportunity to update the build which mostly does validation while I was at it. I probably should have separated them into different PRs, but didn't.

8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ from dev to master (and require 3 approvals).
### Check files

The same check-markdown and check-openapi programs that runs as a check on PR's is part of the repo and can be run locally.
To install you'll need npm, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).
Alternatively, you can also use [yarn](https://yarnpkg.com/) instead of npm. In this case replace all occurrences of `npm` with `yarn` below.
To install you'll need npm, which is a standard part of any [node.js installation](https://nodejs.org/en/download/). Any recent version of node/npm should work.

First you'll need to install everything with npm once. Just navigate to the root of the stac-spec repo and on
your command line run:
If using nvm, run `nvm install`.

Install the dependencies with npm:

```bash
npm install
Expand Down
11 changes: 6 additions & 5 deletions collections/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ info:
name: Apache License 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
tags:
- name: Core
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

fixes a few warnings.

description: essential characteristics of a STAC API
- name: Collections
description: |-
All endpoints related to STAC API - Collections
description: All endpoints related to STAC API - Collections
paths:
'/':
get:
tags:
- Features
- Core
summary: landing page
description: |-
The landing page provides links to the sub-resources.
Expand Down Expand Up @@ -72,7 +73,7 @@ paths:
'/collections':
get:
tags:
- Features
- Collections
summary: the feature collections in the dataset
description: |-
A body of Feature Collections that belong or are used together with additional links.
Expand All @@ -86,7 +87,7 @@ paths:
'/collections/{collectionId}':
get:
tags:
- Features
- Collections
summary: |-
describe the feature collection with id `collectionId`
description: |-
Expand Down
2 changes: 0 additions & 2 deletions fragments/filter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,6 @@ Formal definitions and grammars for CQL2 can be found here:
- [cql.bnf](https://github.com/opengeospatial/ogcapi-features/blob/master/extensions/cql/standard/schema/cql.bnf)
- [cql.json](https://github.com/opengeospatial/ogcapi-features/blob/master/extensions/cql/standard/schema/cql.json)
- [cql.yml](https://github.com/opengeospatial/ogcapi-features/blob/master/extensions/cql/standard/schema/cql.yml)
- A JSON Schema for only the parts of the CQL2 JSON encoding required by this extension is [here](cql.json)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

edited cql.json has been removed, as we no longer have a custom version

- A OpenAPI specification for only the parts of the CQL2 JSON encoding required by this extension is [here](cql.yml)
- xtraplatform-spatial has a CQL2 [ANTLR 4 grammer](https://github.com/interactive-instruments/xtraplatform-spatial/tree/master/xtraplatform-cql/src/main/antlr/de/ii/xtraplatform/cql/infra)

These projects have or are developing CQL or CQL2 support:
Expand Down
Loading