Fix proposal for #319 #327

gfenoy · 2023-05-30T11:31:19Z

This changes should solve the issue #319 related to moving the schemas location from the extension specific openapi subdirectory to root.

jerstlouis · 2023-05-30T11:45:49Z

Thanks @gfenoy !

We should also add the (POST) paths for processes-dru to openapi/paths and then include them in ogcapi-processes.yaml. Then if it works with your demo API, we could add your server as an example supporting DRU to the list of example servers.

You could also potentially use the example OpenAPI definition to assemble your API definition for your implementation, with swagger-cli bundle ogcapi-processes.yaml. Simply comment out any paths that your API doesn't implement, tweak the process-list.json to the processes your API supports (or return it dynamically from your server at/api/process-list), and add any extra things that you support as custom extensions or from other OGC APIs (several of which now following this structure).

Introduce fix for issue opengeospatial#328

openapi/ogcapi-processes.yaml

Rename responses schemas using the r prefix

gfenoy · 2023-05-30T16:09:45Z

I have made the renaming using the r prefix for responses

gfenoy · 2023-05-30T16:12:35Z

Thanks @jerstlouis, it is a very nice way to validate our changes to use the swagger-cli bundle ogcapi-processes.yaml command.

jerstlouis · 2023-05-30T16:14:06Z

@gfenoy Now you can add your server to the list of examples and say it supports DRU :) Then we can test it all directly from SwaggerUI. You can also do swagger-cli validate ogcapi-processes.yaml. And sometimes the SwaggerUI will find more problems (bottom icon will say invalid). You can just point SwaggerUI (https://petstore.swagger.io/?url=) to the bundled JSON file.

gfenoy · 2023-05-30T16:22:30Z

@jerstlouis should I also push the bundle to replace the current one?

I ask this question because I noticed that there is no mention of Part 3 in the ogcapi-processes.yaml.

Also, we may think of having the following files:

openapi/ogcapi-processes-1.yaml: include the current ogcapi-processes.yaml file (before the modifications I made)
openapi/ogcapi-processes-2.yaml: include the ogcapi-processes.yaml offering both part 1 and part 2 definitions
openapi/ogcapi-processes-3.yaml: include the ogcapi-processes.yaml offering both part 1, part 2 and part 3 definitions

What do you think?

jerstlouis · 2023-05-30T16:32:11Z

@gfenoy Yes you can update the updated bundle.

t there is no mention of Part 3 in the ogcapi-processes.yaml.

That's because Part 3 does not really define any new paths, it only extends the execution request and defines the response=collection/landingPage on the POST to /execution.

Also, we may think of having the following files:

I think it's simpler to just include everything in a single ogcapi-processes.yaml, and developers can comment out the paths they do not implement when they bundle their own OGC API.
This is why I suggest it would be great if you can add your server which implements Part 2 as an additional API deployment example, since our server that is currently the only one there in the list only supports Part 1 and 3.

gfenoy · 2023-05-30T16:51:07Z

This is why I suggest it would be great if you can add your server which implements Part 2 as an additional API deployment example

I will proceed after we get confirmation that once deployed a Server Instance relying on the proposed new schemas is properly working.

Adjust adoc as needed

@fmigneault

Thanks @fmigneault for feebcaks on opengeospatial#319

openapi/responses/processes-dru/rDeployProcess.yaml

Add short documentation on how to generate the desired files. Small fix to make operationId unique

Use type string for application/cwl

@jerstlouis

Add instructions to generated the files in the README Thanks @jerstlouis for the comment about this

As per opengeospatial#282 (comment), remove CommonWorkflowLanguage.yml

jerstlouis · 2023-05-31T11:33:37Z

openapi/README.md

@@ -8,7 +8,7 @@ The list of supported paths should be ajusted in `ogcapi-processes-3.yaml`.

 The `ogcapi-processes-3.bundled.json` was generated with `swagger-cli bundle` from `ogcapi-processes-3.yaml` and its dependencies included from the components sub-directories.

-The `paths/processes-dru/pProcessListDeploy.yaml` and `paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml` files are generated by concatening multiple files in a single one. you can sue the command bellow to update their value with the current schema:
+The `paths/processes-dru/pProcessListDeploy.yaml` and `paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml` files are generated by concatening multiple files in a single one. you can use the command bellow to update their value with the current schema:


Thanks @gfenoy . bellow is still wrong though :) (below)

Thanks for your patience @jerstlouis

@gfenoy No thank you for yours ;) Sorry for being so annoying finding things to fix :P

jerstlouis · 2023-05-31T12:05:49Z

openapi/parameters/processes-dru/w-param.yaml

@@ -0,0 +1,5 @@
+name: w


@gfenoy What's w for? Can we add a description?

@jerstlouis it is used to point to the workflow id to be deployed from a CWL containing multiple workflow definitions.

I have added the description, I hope it is clear.

fmigneault · 2023-05-31T23:40:06Z

@gfenoy
See #329 for the CWL schema discussed in #319.

gfenoy · 2023-06-07T10:49:40Z

@fmigneault following the discussion there.

My understanding is that the schema will be made available from there https://github.com/common-workflow-language/cwl-v1.2/.

I don't know yet if we we plan to keep a copy of the schema also in this repository. I would like to have a confirmation about this.

If not, then I will wait for the schema to be made available there to update the schema to reference this schema.

fmigneault · 2023-06-07T17:16:01Z

@gfenoy
I think it would be better to use the published external reference to make sure it stays up-to-date with any fixes applied on the CWL side.

fmigneault · 2023-07-19T13:09:44Z

@gfenoy @jerstlouis
The official CWL JSON schema is now available here:
https://github.com/common-workflow-language/cwl-v1.2/blob/1.2.1_proposed/json-schema/cwl.yaml

openapi/paths/processes-dru/pDeploy.yaml

fmigneault · 2023-07-19T13:22:50Z

@gfenoy

In these two definitions, I recall having a nested unit or href mapping that allowed respectively to either pass the definitions direct;y as JSON, or provide an external reference to a document containing the execution unit contents.

https://github.com/GeoLabs/ogcapi-processes/blob/a8347b5f2c9e37e4581b68739120e62c4ea1317a/openapi/schemas/processes-dru/ogcapppkg-array.yaml#L3-L6

  oneOf:
    - $ref: "executionUnit.yaml"
    - $ref: "../common-core/link.yaml"
    - $ref: "../processes-core/qualifiedInputValue.yaml"

https://github.com/GeoLabs/ogcapi-processes/blob/a8347b5f2c9e37e4581b68739120e62c4ea1317a/openapi/schemas/processes-dru/ogcapppkg.yaml#L7-L12

  executionUnit:
    oneOf:
      - $ref: "executionUnit.yaml"
      - $ref: "../common-core/link.yaml"
      - $ref: "../processes-core/qualifiedInputValue.yaml"
      - $ref: "ogcapppkg-array.yaml"

The href variant would be handled by "../common-core/link.yaml", but the unit one is missing.

Also, https://raw.githubusercontent.com/common-workflow-language/cwl-v1.2/1.2.1_proposed/json-schema/cwl.yaml can now be added to those lists as well.

@fmigneault

Thanks @fmigneault for this great work. Co-authored-by: Francis Charette-Migneault <[email protected]>

fmigneault · 2023-08-16T14:06:58Z

@gfenoy Is there something still blocking this PR?

gfenoy · 2023-08-21T07:43:02Z

@fmigneault we were discussing about merging this PR during the last SWG meeting and no objection was raised.

I plan to attend the today meeting and hope we can get this PR merged during the SWG meeting except if an objection is exposed.

In case you have time, it would be great to have you attending the meeting to support this PR.

pvretano · 2023-08-21T13:09:05Z

21-AUG-2023: SWG reviewed the PR and agreed to merge. If any issues arrive after the fact, new issues can be created to address those.

Fix proposal for opengeospatial#319

38ce0b5

gfenoy added 2 commits May 30, 2023 14:52

Add missing paths files and addition of part 2 in ogcapi-processes.yaml

0e403c8

Fix typo in name directory and ogcapi-processes

0e4d928

gfenoy mentioned this pull request May 30, 2023

Reconsider status codes for DRU immutable and duplicate process responses #328

Closed

Fix issue when using swagger-cli bundle

dbac653

Introduce fix for issue opengeospatial#328

pvretano reviewed May 30, 2023

View reviewed changes

openapi/ogcapi-processes.yaml Outdated Show resolved Hide resolved

Fix location of the reference section for Deploy, Replace and Undeploy

9f1e66f

Rename responses schemas using the r prefix

Fix references typo, adding r prefix

62f3743

gfenoy added 2 commits May 30, 2023 20:19

Fix comment from @fmigneault opengeospatial#328

c2b5051

Adjust adoc as needed

Add missing content types

24077f6

Thanks @fmigneault for feebcaks on opengeospatial#319

gfenoy mentioned this pull request May 30, 2023

Inconsistent schemas in DRU extension since OpenAPI restructure #319

Closed

Fix typo in rDeployProcess.yaml

e98f6f7

pvretano reviewed May 30, 2023

View reviewed changes

openapi/responses/processes-dru/rDeployProcess.yaml Outdated Show resolved Hide resolved

gfenoy added 5 commits May 31, 2023 00:18

Add required yaml files composed of various existing schemas

26e325b

Add short documentation on how to generate the desired files. Small fix to make operationId unique

Use CommonWorkflowLanguage.yml as schema for application/cwl+json

16ba65b

Use type string for application/cwl

Remove long comments from ogcapi-processes.yaml

1cfc632

Add instructions to generated the files in the README Thanks @jerstlouis for the comment about this

Fix indentation and remove the CommonWorkflowLanguage.yml

b47410e

As per opengeospatial#282 (comment), remove CommonWorkflowLanguage.yml

Fix typo in the README.

9843ce5

jerstlouis reviewed May 31, 2023

View reviewed changes

Fix typo in README

e1e204f

jerstlouis reviewed May 31, 2023

View reviewed changes

Add description for choosing workflow to be deployed using the w-param

a8347b5

gfenoy added the Part 2 (DRU) label Jun 1, 2023

fmigneault mentioned this pull request Jun 13, 2023

Add JSON schema for CWL and conformance tests validating it common-workflow-language/cwl-v1.2#256

Merged

fmigneault reviewed Jul 19, 2023

View reviewed changes

openapi/paths/processes-dru/pDeploy.yaml Outdated Show resolved Hide resolved

fmigneault mentioned this pull request Jul 19, 2023

Add the official CWL JSON schema reference crim-ca/weaver#547

Closed

Update openapi/paths/processes-dru/pDeploy.yaml

f0743bb

Thanks @fmigneault for this great work. Co-authored-by: Francis Charette-Migneault <[email protected]>

pvretano merged commit 1297e3b into opengeospatial:master Aug 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix proposal for #319 #327

Fix proposal for #319 #327

gfenoy commented May 30, 2023

jerstlouis commented May 30, 2023 •

edited

Loading

gfenoy commented May 30, 2023

gfenoy commented May 30, 2023

jerstlouis commented May 30, 2023 •

edited

Loading

gfenoy commented May 30, 2023 •

edited

Loading

jerstlouis commented May 30, 2023 •

edited

Loading

gfenoy commented May 30, 2023

jerstlouis May 31, 2023 •

edited

Loading

gfenoy May 31, 2023 •

edited

Loading

jerstlouis May 31, 2023

jerstlouis May 31, 2023

gfenoy May 31, 2023

jerstlouis May 31, 2023

fmigneault commented May 31, 2023

gfenoy commented Jun 7, 2023

fmigneault commented Jun 7, 2023

fmigneault commented Jul 19, 2023

fmigneault commented Jul 19, 2023 •

edited

Loading

fmigneault commented Aug 16, 2023

gfenoy commented Aug 21, 2023

pvretano commented Aug 21, 2023

Fix proposal for #319 #327

Fix proposal for #319 #327

Conversation

gfenoy commented May 30, 2023

jerstlouis commented May 30, 2023 • edited Loading

gfenoy commented May 30, 2023

gfenoy commented May 30, 2023

jerstlouis commented May 30, 2023 • edited Loading

gfenoy commented May 30, 2023 • edited Loading

jerstlouis commented May 30, 2023 • edited Loading

gfenoy commented May 30, 2023

jerstlouis May 31, 2023 • edited Loading

Choose a reason for hiding this comment

gfenoy May 31, 2023 • edited Loading

Choose a reason for hiding this comment

jerstlouis May 31, 2023

Choose a reason for hiding this comment

jerstlouis May 31, 2023

Choose a reason for hiding this comment

gfenoy May 31, 2023

Choose a reason for hiding this comment

jerstlouis May 31, 2023

Choose a reason for hiding this comment

fmigneault commented May 31, 2023

gfenoy commented Jun 7, 2023

fmigneault commented Jun 7, 2023

fmigneault commented Jul 19, 2023

fmigneault commented Jul 19, 2023 • edited Loading

fmigneault commented Aug 16, 2023

gfenoy commented Aug 21, 2023

pvretano commented Aug 21, 2023

jerstlouis commented May 30, 2023 •

edited

Loading

jerstlouis commented May 30, 2023 •

edited

Loading

gfenoy commented May 30, 2023 •

edited

Loading

jerstlouis commented May 30, 2023 •

edited

Loading

jerstlouis May 31, 2023 •

edited

Loading

gfenoy May 31, 2023 •

edited

Loading

fmigneault commented Jul 19, 2023 •

edited

Loading