Skip to content

Commit 14e952c

Browse files
committed
SP edits for pub: API - Part 1
1 parent ad88af9 commit 14e952c

30 files changed

Lines changed: 123 additions & 137 deletions

api/part1/openapi/examples/collections/collections1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"id": "all_systems",
55
"title": "All Connected Systems",
6-
"description": "All systems registered on this server (e.g. platforms, sensors, actuators, processes)",
6+
"description": "All systems registered on this server (e.g., platforms, sensors, actuators, processes)",
77
"itemType": "feature",
88
"featureType": "ssn:System",
99
"links": [
@@ -18,7 +18,7 @@
1818
{
1919
"id": "all_procedures",
2020
"title": "All Procedures and System Datasheets",
21-
"description": "All procedures (e.g. system datasheets) implemented by systems registered on this server",
21+
"description": "All procedures (e.g., system datasheets) implemented by systems registered on this server",
2222
"itemType": "feature",
2323
"featureType": "sosa:Procedure",
2424
"links": [

api/part1/openapi/openapi-connectedsystems-1.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ tags:
3838
In particular, Collections allow a service provider to group resources logically according to any criteria.
3939
4040
For example, collections can be used to:
41-
- Group all `Systems` of the same type (e.g. all UAV platforms, all hydrological sensors, etc.).
42-
- Group all `Procedures` of the same type (e.g. all platform types, all CBRNE sensor models, etc.).
43-
- Group resources by project (e.g. all `Deployments`, `Systems`, `Datastreams` and `Sampling Features` relevant to a given data acquisition campaign)
41+
- Group all `Systems` of the same type (e.g., all UAV platforms, all hydrological sensors, etc.).
42+
- Group all `Procedures` of the same type (e.g., all platform types, all CBRNE sensor models, etc.).
43+
- Group resources by project (e.g., all `Deployments`, `Systems`, `Datastreams` and `Sampling Features` relevant to a given data acquisition campaign)
4444
4545
- name: Systems
4646
description: |-
47-
Systems are entities that can produce data feeds and/or receive commands (e.g. sensors and sensor networks, platforms, actuators,
47+
Systems are entities that can produce data feeds and/or receive commands (e.g., sensors and sensor networks, platforms, actuators,
4848
processing components, etc.). Many systems can be classified as 'observing systems' that produce observations of one or more
4949
features of interest.
5050
- name: Deployments
@@ -53,8 +53,8 @@ tags:
5353
- name: Procedures
5454
description: |-
5555
Procedures provide information about the behavior of a system to accomplish its task(s).
56-
Procedures include descriptions of system kinds (e.g. a hardware device's datasheet), as well as methodologies or specific
57-
configurations of these systems (e.g. steps followed by an operator to accomplish a sensing or sampling task).
56+
Procedures include descriptions of system kinds (e.g., a hardware device's datasheet), as well as methodologies or specific
57+
configurations of these systems (e.g., steps followed by an operator to accomplish a sensing or sampling task).
5858
- name: Sampling Features
5959
description: |-
6060
Sampling Features link Systems with ultimate features of interest, describing exactly what part of a larger feature is being
@@ -66,7 +66,7 @@ tags:
6666
Derived properties are specific to a type of feature, a type of system, or even to a particular organization, project or deployment.
6767
Property definitions are referenced by feature schemas, system and deployment descriptions, datastream and control stream schemas, etc.
6868
69-
Depending on the context they are used in, they can represent properties that are asserted (e.g. system characteristic), observed
69+
Depending on the context they are used in, they can represent properties that are asserted (e.g., system characteristic), observed
7070
(observed or observable property) or controlled (controlled or controllable property).
7171
7272
paths:

api/part1/openapi/paths/collectionItems.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ post:
2424
Add a new resource to the parent collection.
2525
2626
If actual resource descriptions are provided in the body, new resources will be created and added to the parent collection.
27-
The new resources will also be available at the corresponding canonical resources endpoint (e.g. `/systems` if the resource is a system).
27+
The new resources will also be available at the corresponding canonical resources endpoint (e.g., `/systems` if the resource is a system).
2828
2929
Existing resources can also be added to a collection by providing one or more links to existing resources.
3030
tags:

api/part1/openapi/paths/subsystems.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
get:
22
summary: List subsystems
33
description: |-
4-
List or search all `System` resources that are subsystems (i.e. components) of a specific parent system.
4+
List or search all `System` resources that are subsystems (i.e., components) of a specific parent system.
55
66
Note that individual members can also be retrieved by ID directly at the canonical `System` resources endpoint.
77
tags:

api/part1/openapi/paths/systems.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ get:
33
description: |-
44
List or search all `System` resources available from this server endpoint.
55
6-
By default, only top level systems are included (i.e. subsystems are ommitted) unless the `parent` query parameter is set.
6+
By default, only top level systems are included (i.e., subsystems are ommitted) unless the `parent` query parameter is set.
77
88
tags:
99
- Systems
@@ -39,7 +39,7 @@ get:
3939
post:
4040
summary: Create a new system
4141
description: |-
42-
Add a new top-level `System` resource (i.e. the system will have no parent).
42+
Add a new top-level `System` resource (i.e., the system will have no parent).
4343
tags:
4444
- Systems
4545
requestBody:

api/part1/openapi/schemas/geojson/deployedSystem.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"$ref": "../common/commonDefs.json#/$defs/Link"
1313
},
1414
"procedure@link": {
15-
"description": "Link to the procedure used by the system, or to operate the system, during the deployment (e.g. mission plan for an autonomous system, methodology for human operator).",
15+
"description": "Link to the procedure used by the system, or to operate the system, during the deployment (e.g., mission plan for an autonomous system, methodology for human operator).",
1616
"$ref": "../common/commonDefs.json#/$defs/Link"
1717
}
1818
}

api/part1/openapi/schemas/geojson/system.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"$ref": "../common/commonDefs.json#/$defs/TimePeriod"
2828
},
2929
"systemKind@link": {
30-
"description": "Link to the system kind description (i.e. its nature or specifications).",
30+
"description": "Link to the system kind description (i.e., its nature or specifications).",
3131
"$ref": "../common/commonDefs.json#/$defs/Link"
3232
}
3333
}

api/part1/openapi/schemas/sensorml/deployedSystem.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
{
66
"properties": {
77
"id": {
8-
"description": "Local ID of the deployed system resource (e.g. locally unique on a server)",
8+
"description": "Local ID of the deployed system resource (e.g., locally unique on a server)",
99
"type": "string",
1010
"minLength": 1,
1111
"readOnly": true

api/part1/standard/23-001r0.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
:doctype: standard
33
:encoding: utf-8
44
:lang: en
5-
:status: draft
5+
:status: approved
66
:committee: technical
77
:external-id: http://www.opengis.net/doc/DIS/ogcapi-connectedsystems-1/1.0
8-
:docnumber: 23-001r0
9-
:received-date: yyyy-mm-dd
10-
:issued-date: yyyy-mm-dd
8+
:docnumber: 23-001
9+
:received-date: 2025-03-19
10+
:issued-date: 2025-06-02
1111
:published-date: yyyy-mm-dd
1212
:fullname: Alex Robin
1313
:docsubtype: implementation

api/part1/standard/requirements/subsystem/req_subcollection_time.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[%metadata]
44
identifier:: /rec/subsystem/collection-datetime
55
6-
part:: When the `datetime` parameter is omitted, the server SHOULD also include all subsystems that are currently deployed on the parent system (i.e. the association is made via a `Deployment` resource that is currently valid).
6+
part:: When the `datetime` parameter is omitted, the server SHOULD also include all subsystems that are currently deployed on the parent system (i.e., the association is made via a `Deployment` resource that is currently valid).
77
88
part:: When the `datetime` parameter is set to a time instant, the server SHOULD also include all subsystems that were deployed on the parent system at the specified time. This condition is true when the association is made via a `Deployment` resource whose valid time period contains the specified time instant.
99

0 commit comments

Comments
 (0)