Introduce Conformance API to configure OGCAPI Features by jodygarnett · Pull Request #8014 · geoserver/geoserver

jodygarnett · 2024-11-07T08:26:16Z

Looking at how to add conformance to the ogcapi-core as something we can configure on and off.

Registers an AdminPagePanel with WFSInfo to be shown on the WFS page:

Feedback welcome.

Checklist

I have read the contribution guidelines.
I have sent a Contribution Licence Agreement (not required for small changes, e.g., fixing typos in documentation).
First PR targets the main branch (backports managed later; ignore for branch specific issues).
All the build checks are green (see automated QA checks).

For core and extension modules:

New unit tests have been added covering the changes.
Documentation has been updated (if change is visible to end users).
The REST API docs have been updated (when changing configuration objects or the REST controllers).
There is an issue in the GeoServer Jira (except for changes that do not affect administrators or end users in any way).
Commit message(s) must be in the form [GEOS-XYZWV] Title of the Jira ticket.
Bug fixes and small new features are presented as a single commit.
Each commit has a single objective (if there are multiple commits, each has a separate JIRA ticket describing its goal).

aaime

I like the initial idea, looking forward to see some GUI to configure, how it's stored, and how it's eventually used to control the service behavior.

Left a bunch of comments below.

src/community/ogcapi/ogcapi-core/src/main/java/org/geoserver/ogcapi/APIConformance.java

src/community/ogcapi/ogcapi-core/src/main/java/org/geoserver/ogcapi/ConformanceInfo.java

...ty/ogcapi/ogcapi-features/src/main/java/org/geoserver/ogcapi/v1/features/FeatureService.java

src/web/core/src/test/java/org/geoserver/web/admin/StatusPageTest.java

aaime

Had a look and provided some comments. Will be interesting to see how you want to address turning off some behavior. Or are you settling down to just stop advertising it, but then leave it there?

...y/ogcapi/ogcapi-features/src/main/java/org/geoserver/ogcapi/v1/features/CQL2Conformance.java

...y/ogcapi/ogcapi-features/src/test/java/org/geoserver/ogcapi/v1/features/ConformanceTest.java

aaime · 2024-11-25T15:00:37Z

...ity/ogcapi/web-features/src/main/java/org/geoserver/ogcapi/web/FeatureServiceAdminPanel.html

I did not expect to see this page hand-written... actually it might be a problem.
What if a given conformance class is provided through a plugin?

Probably better to have enough configuration to auto-generate this from the conformance classes that might be found in the spring context.

I am walking before I can run on this one Andrea. I think the next step is to make a conformance panel that can be used multiple times.

Want to get something that functions at all here to control the module.

If a conformance class is provided through a plugin it provides its own AdminPagePanel, as that is the existing UI infrastructure for contributing.

That is one possibility, but it's work-intensive and clumsy. Alsor remember admin panels are not following an order, you can have panels out of any logical order, and other unrelated extensions have their eventual panel show up in the middle.

I am thinking how to do that, and we have an extension that provides:

APIConformance being configured

property expression metadata/cql2/text from WFSInfo

Then FeatureServiceAdminPanel could do the very simple story we have now. But not additional settings.

May be better to have an extension like ConformancePanel, with a default implementation for the simple case.

aaime

Had another go looking at the diff (but could not try it out interactively yet)

...y/ogcapi/ogcapi-features/src/main/java/org/geoserver/ogcapi/v1/features/CQL2Conformance.java

...ty/ogcapi/ogcapi-features/src/main/java/org/geoserver/ogcapi/v1/features/FeatureService.java

...gcapi/ogcapi-features/src/main/java/org/geoserver/ogcapi/v1/features/FeatureConformance.java

...rc/main/java/org/geoserver/ogcapi/v1/features/FeatureServiceXStreamPersisterInitializer.java

aaime · 2024-11-27T18:29:52Z

...gcapi/ogcapi-features/src/main/java/org/geoserver/ogcapi/v1/features/FeaturesAPIBuilder.java

Based on configuration, the sortby, filter, filter-lang parameters should also be removed (and so on)

path: search, queryables and functions now removable

parameters: filter, filter-lang, sortBy now removable

...ogcapi/ogcapi-core/src/main/java/org/geoserver/ogcapi/OGCAPIXStreamPersisterInitializer.java

...ity/ogcapi/web-features/src/main/java/org/geoserver/ogcapi/web/FeatureServiceAdminPanel.java

This repalce status and provides concepts such as COMMUNITY_STANDARD and RETIRED_STANDARD

…L2Conformance

…ication etc...

The checkboxes in FeatureServiceAdminPanel would otherwise update the model value to false when it was originally null. This way the XStream persister will get the unchanged values as null instead of false.

jodygarnett · 2024-11-29T05:55:19Z

Rebased to get the cite fixes from main branch. Addressed formatting and QA failures also.

jodygarnett requested a review from aaime November 7, 2024 08:26

jodygarnett force-pushed the api-conformance-info branch from 59c7f4b to 42d106c Compare November 7, 2024 08:29

aaime reviewed Nov 7, 2024

View reviewed changes

jodygarnett mentioned this pull request Nov 8, 2024

Designing and Implementing a Mechanism to Enable/Disable Optional/Non-Finalized Parts of the Specification geoserver/geoserver-ogcapi#3

Open

jodygarnett force-pushed the api-conformance-info branch 2 times, most recently from 7c327c2 to 1dd5158 Compare November 22, 2024 08:21

aaime reviewed Nov 25, 2024

View reviewed changes

jodygarnett marked this pull request as ready for review November 26, 2024 06:00

jodygarnett force-pushed the api-conformance-info branch 2 times, most recently from b14d6ea to 558c349 Compare November 26, 2024 06:06

jodygarnett changed the title ~~[WIP] APIConformance~~ Introduce Conformance API to configure OGCAPI Features Nov 26, 2024

jodygarnett force-pushed the api-conformance-info branch 2 times, most recently from 7159088 to 215fc7c Compare November 26, 2024 22:22

aaime reviewed Nov 27, 2024

View reviewed changes

jodygarnett force-pushed the api-conformance-info branch from f67a98a to df36c0e Compare November 28, 2024 08:15

jodygarnett added 15 commits November 28, 2024 21:54

APIConformance outline

560ff5f

cleanup

7ee3086

Outline ConformanceAdminPanel

1b35682

Update APIConformance with OGC Standard Level language

2ebf43a

This repalce status and provides concepts such as COMMUNITY_STANDARD and RETIRED_STANDARD

Working AdminPagePanel for FeatureConformance, ECQLConformance and CQ…

f49989b

…L2Conformance

Add CQL2 to FeatureServiceAdminPanel

29d7bc5

minor formatting

fcacef7

Work on load/save

bfe7859

Change to java beans configuration

9fd490d

Save feature service configuraiton beans

9a64431

Visual feedback for conformance null / null / true / flase state

3376430

Use conformance to check parameters, provide warning when ignored

7b9a964

Document new configuration options

e7dda7f

Fix checkstyle violation

fdd641c

Revise based on feedabck and discussion

f386f6c

jodygarnett and others added 6 commits November 28, 2024 21:54

Double check GMLSF2 is disabled to confirm CITE tests should pass

f16bc34

Connect search, queryable and functions

f1bde8f

Adress feedback, fix headers, remove commeneded out code, remove dupl…

221c878

…ication etc...

Headers

238a16b

Use a three-state checkbox to preserve conformance default value

9fc1c51

The checkboxes in FeatureServiceAdminPanel would otherwise update the model value to false when it was originally null. This way the XStream persister will get the unchanged values as null instead of false.

Address QA and formatting warnings

362c961

jodygarnett force-pushed the api-conformance-info branch from e065fce to 362c961 Compare November 29, 2024 05:54

jodygarnett merged commit 3a8c52c into geoserver:main Nov 29, 2024

jodygarnett deleted the api-conformance-info branch November 29, 2024 06:27

Uh oh!

Conversation

jodygarnett commented Nov 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

aaime left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aaime left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

aaime Nov 25, 2024

Choose a reason for hiding this comment

Uh oh!

jodygarnett Nov 26, 2024

Choose a reason for hiding this comment

Uh oh!

jodygarnett Nov 26, 2024

Choose a reason for hiding this comment

Uh oh!

aaime Nov 26, 2024

Choose a reason for hiding this comment

Uh oh!

jodygarnett Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

aaime left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aaime Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

jodygarnett Nov 28, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jodygarnett commented Nov 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jodygarnett commented Nov 7, 2024 •

edited

Loading