-
Notifications
You must be signed in to change notification settings - Fork 45
add DRU replace operation precisions #578
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
Open
fmigneault
wants to merge
6
commits into
opengeospatial:master
Choose a base branch
from
crim-ca:replace-precisions
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
01521cd
add PUT replace unsert details + add missing/alternate replace HTTP c…
fmigneault 9dd2d38
add missing text part of replace/insert permission
fmigneault 1b3c5a8
fix wrong rec
fmigneault 64f035e
add missing req/rec/per includes
fmigneault 9734d5a
move processes replace version links to potential versioning part
fmigneault 4997147
adjust history
fmigneault File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
...andard/recommendations/deploy-replace-undeploy/replace/PER_response-insert.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| [[per_deploy-replace-undeploy_replace_response-insert]] | ||
| [permission] | ||
| ==== | ||
| [%metadata] | ||
| identifier:: /per/deploy-replace-undeploy/replace-response-insert | ||
|
|
||
| [.component,class=part] | ||
| -- | ||
| A server MAY support immediate creation of the initial process definition when none exists using the HTTP PUT operation | ||
| in an "upsert" fashion (i.e.: update or insert as applicable). In this case, the process creation SHOULD behave as if it | ||
| was directly submitted for deployment as per <<req_deploy-replace-undeploy_deploy_post-op,/req/deploy-replace-undeploy/deploy-post-op>>. | ||
| -- | ||
|
|
||
| [.component,class=part] | ||
| -- | ||
| If the operation results in an insertion creating a new process definition rather than an update, it SHOULD reflect | ||
| the appropriate HTTP status code as per the requirement | ||
| <<req_deploy-replace-undeploy_replace_response,/req/deploy-replace-undeploy/replace-response>>. | ||
| -- | ||
|
|
||
| ==== | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
...oy/standard/requirements/deploy-replace-undeploy/replace/REQ_response-body.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| [[req_deploy-replace-undeploy_replace_response-body]] | ||
| [requirement] | ||
| ==== | ||
| [%metadata] | ||
| identifier:: /req/deploy-replace-undeploy/replace-response-body | ||
|
|
||
| [.component,class=part] | ||
| -- | ||
| If the replacement response employs HTTP status code `200`, `201` or `202` accordingly to | ||
| requirement <<req_deploy-replace-undeploy_replace_response,/req/deploy-replace-undeploy/replace-response>>, | ||
| the response body SHALL conform to the summary description of the process | ||
| as per https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/processSummary.yaml[processSummary.yaml] schema. | ||
| -- | ||
|
|
||
| [.component,class=part] | ||
| -- | ||
| If the replacement response employs HTTP status code `204`, the response body SHALL be empty | ||
| as per standard HTTP specification. | ||
| -- | ||
|
|
||
| ==== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Backup of versioning definitions to be considereconditions::d for a separate part. |
24 changes: 24 additions & 0 deletions
24
extensions/versioning/standard/recommendations/process/REC_response-links.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| [[rec_versioning_process_response-links]] | ||
| [recommendation] | ||
| ==== | ||
| [%metadata] | ||
| identifier:: /rec/versioning/replace-response-links | ||
| conditions:: The server supports DRU <<req_deploy-replace-undeploy_replace_response,/req/deploy-replace-undeploy/replace-response>> | ||
|
|
||
| [.component,class=part] | ||
| -- | ||
| If a server supports multiple versions of a process definition as per | ||
| <<req_deploy-replace-undeploy_replace_response,/req/deploy-replace-undeploy/replace-response>>, | ||
| its process description `links` SHOULD consider providing references to these versions for improved retrieval. | ||
| Such links SHOULD use standard | ||
| <<rfc5829,RFC 5829 Link Relation Types for Simple Version Navigation between Web Resources>>. | ||
| -- | ||
|
|
||
| [.component,class=part] | ||
| -- | ||
| If the `latest-version` link relation type is provided, it SHOULD point to the latest version of | ||
| the process definition or an equivalent description corresponding to the `/processes/{processID}` endpoint | ||
| after resource resolution. | ||
| -- | ||
|
|
||
| ==== |
22 changes: 22 additions & 0 deletions
22
extensions/versioning/standard/sections/annex_bibliography.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| [bibliography] | ||
| [[Bibliography]] | ||
| == Bibliography | ||
|
|
||
| //// | ||
| The TC has approved Springer LNCS as the official document citation type. | ||
|
|
||
| Springer LNCS is widely used in technical and computer science journals and other publications | ||
|
|
||
| * For citations in the text please use square brackets and consecutive numbers: [1], [2], [3] | ||
|
|
||
| – Actual References: | ||
|
|
||
| [n] Journal: Author Surname, A.: Title. Publication Title. Volume number, Issue number, Pages Used (Year Published) | ||
|
|
||
| [n] Web: Author Surname, A.: Title, http://Website-Url | ||
|
|
||
| * [[[OGC2015,OGCTB12]]], _OGC: OGC Testbed 12 Annex B: Architecture_ (2015). | ||
|
|
||
| //// | ||
|
|
||
| * [[[rfc5829]]] Internet Engineering Task Force (IETF). RFC 5829: **Link Relation Types for Simple Version Navigation between Web Resources** [online]. Edited by A. Brown, G. Clemm, J. Reschke. 2010 [viewed 2026-04-14]. Available at https://www.rfc-editor.org/rfc/rfc5829.html |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| [appendix] | ||
| == Revision History | ||
|
|
||
| [cols="12,18,12,12,46",options="header,unnumbered"] | ||
| |=== | ||
| |Date |Release |Editor | Primary clauses modified |Description | ||
| |2026-04-16 |None |Francis Charette-Migneault |Process |Add versioning link RFC 5829 recommendation if employed for DRU process replacement. | ||
| |=== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is identified as a permission (firt part uses MAY) but includes a recommendation (SHOULD) inside for second part.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there actually something against that term? How to indicate something optional, but if you do, it should be done that way ideally? "SHOULD" is still optional / not prescriptive (unlike SHALL).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Otherwise transform it as a recommendation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fmigneault Usually we try to strictly use SHALL in requirements, MAY in permission, and SHOULD in recommendations. One way I've done it e.g. in the Coverages issue we've been working on together lately is by having a separate recommendation in the context of (immediately following) the permission.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One issue is that I don't find it too appropriate to make it a recommendation and use SHOULD for the first part, since supporting "PUT as insert" is really an extra to the more classical HTTP 200 of inplace replacement.