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.

Sign up for GitHub

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

Convert core to Metanorma #4

Merged
merged 18 commits into from
Aug 20, 2021
Merged

Convert core to Metanorma #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
4de9c24
Rename "processId.yaml" and "processid.yaml" to resolve ambiguity
manuelfuenmayor Jul 28, 2021
3bbb6d0
Add core_metanorma folder
manuelfuenmayor Jul 28, 2021
a76a421
Encode Requirement blocks
manuelfuenmayor Jul 29, 2021
8b77529
Encode Requirement blocks
manuelfuenmayor Jul 29, 2021
a2d00a6
Encode Requirements blocks
manuelfuenmayor Jul 29, 2021
50f6c78
Encode Requirement blocks
manuelfuenmayor Jul 29, 2021
748fd42
Encode Permission and Recommendation blocks
manuelfuenmayor Jul 29, 2021
6ec7002
Fix markup bug
manuelfuenmayor Jul 30, 2021
b57ee3d
Encode Abstract Test blocks
manuelfuenmayor Aug 9, 2021
f5cc91e
Update Conformance Class markup
manuelfuenmayor Aug 18, 2021
571eeab
Update Recommendations, Requirements and Permissions Markup
manuelfuenmayor Aug 18, 2021
c5200a6
Update Requirements markup
manuelfuenmayor Aug 18, 2021
5f05496
Include external test-methods into requirement block
manuelfuenmayor Aug 18, 2021
c61cde4
Include external paragraphs into Abstract Test blocks
manuelfuenmayor Aug 18, 2021
bbac53c
Update markup of Requirements, Recomendations and Abstract Tests
manuelfuenmayor Aug 18, 2021
181fff6
Transfer files from "core_metanorma" folder to "core" folder
manuelfuenmayor Aug 19, 2021
bf8a8ba
Delete "core_metanorma" folder
manuelfuenmayor Aug 19, 2021
e4aaa62
Add "document.adoc" file and "sections" folder to core
manuelfuenmayor Aug 19, 2021
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
136 changes: 0 additions & 136 deletions core/18-062.adoc
View file
Open in desktop

This file was deleted.

10 changes: 3 additions & 7 deletions core/abstract_tests/ATS_class_callback.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
[[ats_callback]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback
|Target type |Web API
|Requirements class |<<rc_core,Requirements Class "Core">>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback",subject='<<rc_core,Requirements Class "Core">>',classification="Target Type:Web API"]
====
====

include::callback/ATS_job-creation-callback.adoc[]
10 changes: 3 additions & 7 deletions core/abstract_tests/ATS_class_core.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
[[ats_core]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
|Target type |Web API
|Requirements class |<<rc_core,Requirements Class "Core">>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core",subject='<<rc_core,Requirements Class "Core">>',classification="Target Type:Web API"]
====
====

==== Landing Page /

Expand Down
10 changes: 3 additions & 7 deletions core/abstract_tests/ATS_class_dismiss.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
[[ats_dismiss]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss
|Target type |Web API
|Requirements class |<<rc_core,Requirements Class "Core">>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss",subject='<<rc_core,Requirements Class "Core">>',classification="Target Type:Web API"]
====
====

include::dismiss/ATS_job-dismiss-op.adoc[]

Expand Down
11 changes: 3 additions & 8 deletions core/abstract_tests/ATS_class_html.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
[[ats_html]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html
|Target type |Web API
|Requirements class |<<rc_html,Requirements Class "HTML">>
|Dependency |<<ats_core,Conformance Class 'Core'>>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss",subject='<<rc_core,Requirements Class "Core">>',inherit='<<ats_core,Conformance Class "Core">>',classification="Target Type:Web API"]
====
====

include::html/ATS_content.adoc[]

Expand Down
10 changes: 3 additions & 7 deletions core/abstract_tests/ATS_class_job-list.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
[[ats_job-list]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list
|Target type |Web API
|Requirements class |<<rc_core,Requirements Class "Core">>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/job-list",subject='<<rc_core,Requirements Class "Core">>',classification="Target Type:Web API"]
====
====

include::job-list/ATS_op.adoc[]

Expand Down
10 changes: 3 additions & 7 deletions core/abstract_tests/ATS_class_json.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
[[ats_json]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json
|Target type |Web API
|Requirements class |<<rc_core,Requirements Class "Core">>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json",subject='<<rc_core,Requirements Class "Core">>',classification="Target Type:Web API"]
====
====

include::json/ATS_definition.adoc[]

11 changes: 3 additions & 8 deletions core/abstract_tests/ATS_class_oas30.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
[[ats_oas30]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30
|Target type |Web API
|Requirements class |<<rc_oas30,Requirements Class "OpenAPI Specification 3.0">>
|Dependency |<<ats_core,Conformance Class 'Core'>>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30",subject='<<rc_oas30,Requirements Class "OpenAPI Specification 3.0">>',inherit='<<ats_core,Conformance Class "Core">>',classification="Target Type:Web API"]
====
====

include::oas30/ATS_completeness.adoc[]

Expand Down
10 changes: 3 additions & 7 deletions core/abstract_tests/ATS_class_ogc-process-description.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
[[ats_ogc-process-description]]
[cols="1,4",width="90%"]
|===
2+|*Conformance Class*
2+|http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description
|Target type |Web API
|Requirements class |<<rc_ogc-process-description,Requirements Class "OGC Process Description">>
|===
[requirement,type="conformanceclass",label="http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description",subject='<<rc_ogc-process-description,Requirements Class "OGC Process Description">>',classification="Target Type:Web API"]
====
====

include::ogc-process-description/ATS_json-encoding.adoc[]

Expand Down
19 changes: 12 additions & 7 deletions core/abstract_tests/callback/ATS_job-creation-callback.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
[[ats_callback_job-callback]]
[width="90%",cols="2,6a"]
|===
^|*Abstract Test {counter:ats-id}* |*/conf/callback/job-callback*
^|Test Purpose |Validate the passing of a subscriber-URL in an execute request.
^|Requirement |<<req_callback_job-callback,/req/callback/job-callback>>
^|Test Method |. Configure a URL endpoint to accept message body from the server.
[requirement,type="abstracttest",label="/conf/callback/job-callback",subject='<<req_callback_job-callback,/req/callback/job-callback>>']
====
[.component,class=test-purpose]
--
Validate the passing of a subscriber-URL in an execute request.
--

[.component,class=test-method]
--
. Configure a URL endpoint to accept message body from the server.
. Create an asynchronous execute request that includes the optional `subscriber` key (see https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/execute.yaml[execute.yaml].
. Execute the asynchronous job using test <<ats_core_job-creation-op,/conf/core/job-creation-request>>.
. Validate the job results are received by the specified callback URL.
|===
--
====
19 changes: 12 additions & 7 deletions core/abstract_tests/core/ATS_api-definition-op.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
[[ats_core_api-definition-op]]
[width="90%",cols="2,6a"]
|===
^|*Abstract Test {counter:ats-id}* |*/conf/core/api-definition-op*
^|Test Purpose |Validate that the API Definition document can be retrieved from the expected location.
^|Requirement |<<req_core_api-definition-op,/req/core/api-definition-op>>
^|Test Method |. Construct a path for the API Definition document that ends with `/api`.
[requirement,type="abstracttest",label="/conf/core/api-definition-op",subject='<<req_core_api-definition-op,/req/core/api-definition-op>>']
====
[.component,class=test-purpose]
--
Validate that the API Definition document can be retrieved from the expected location.
--

[.component,class=test-method]
--
. Construct a path for the API Definition document that ends with `/api`.
. Issue a HTTP GET request on that path
. Validate the contents of the returned document using test <<ats_core_api-definition-success,/conf/core/api-definition-success>>.
|===
--
====
19 changes: 12 additions & 7 deletions core/abstract_tests/core/ATS_api-definition-success.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
[[ats_core_api-definition-success]]
[width="90%",cols="2,6a"]
|===
^|*Abstract Test {counter:ats-id}* |*/conf/core/api-definition-success*
^|Test Purpose |Validate that the API Definition complies with the required structure and contents.
^|Requirement |<<req_core_api-definition-success,/req/core/api-definition-success>>
^|Test Method |. Validate that a document was returned with a status code 200
[requirement,type="abstracttest",label="/conf/core/api-definition-success",subject='<<req_core_api-definition-success,/req/core/api-definition-success>>']
====
[.component,class=test-purpose]
--
Validate that the API Definition complies with the required structure and contents.
--

[.component,class=test-method]
--
. Validate that a document was returned with a status code 200
. Validate the API Definition document against an appropriate schema document.
|===
--
====
19 changes: 12 additions & 7 deletions core/abstract_tests/core/ATS_conformance-op.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
[[ats_core_conformance-op]]
[width="90%",cols="2,6a"]
|===
^|*Abstract Test {counter:ats-id}* |*/conf/core/conformance-op*
^|Test Purpose |Validate that a Conformance Declaration can be retrieved from the expected location.
^|Requirement |<<req_core_conformance-op,/req/core/conformance-op>>
^|Test Method |. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/conformance" link on the landing page as well as for the {root}/conformance path.
[requirement,type="abstracttest",label="/conf/core/conformance-op",subject='<<req_core_conformance-op,/req/core/conformance-op>>']
====
[.component,class=test-purpose]
--
Validate that a Conformance Declaration can be retrieved from the expected location.
--

[.component,class=test-method]
--
. Construct a path for each "rel=http://www.opengis.net/def/rel/ogc/1.0/conformance" link on the landing page as well as for the {root}/conformance path.
. Issue an HTTP GET request on each path
. Validate the contents of the returned document using test <<ats_core_conformance-success,/conf/core/conformance-success>>.
|===
--
====
19 changes: 12 additions & 7 deletions core/abstract_tests/core/ATS_conformance-success.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
[[ats_core_conformance-success]]
[width="90%",cols="2,6a"]
|===
^|*Abstract Test {counter:ats-id}* |*/conf/core/conformance-success*
^|Test Purpose |Validate that the Conformance Declaration response complies with the required structure and contents.
^|Requirement |<<req_core_conformance-success,/req/core/conformance-success>>
^|Test Method |. Validate that a document was returned with an HTTP status code of 200.
[requirement,type="abstracttest",label="/conf/core/conformance-success",subject='<<req_core_conformance-success,/req/core/conformance-success>>']
====
[.component,class=test-purpose]
--
Validate that the Conformance Declaration response complies with the required structure and contents.
--

[.component,class=test-method]
--
. Validate that a document was returned with an HTTP status code of 200.
. Validate the response document against OpenAPI 3.0 schema link: http://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/confClasses.yaml[confClasses.yaml]
. Validate that the document includes the conformance class "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core"
. Validate that the document list all OGC API conformance classes that the API implements.
|===
--
====
Loading