Skip to content

feat: add serviceId to version object #192

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

Merged
jimmarino merged 1 commit into from
Jun 18, 2025
Merged

feat: add serviceId to version object #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions artifacts/src/main/resources/common/example/protocol-version.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
{
"version": "2025-1",
"path": "/some/path/2025-1",
"binding": "HTTPS"
"binding": "HTTPS",
"serviceId": "service-asdf"
},
{
"version": "2024-1",
Expand All @@ -16,7 +17,9 @@
"authorization_code",
"refresh_token"
]
}
},
"serviceId": "service-asdf"

},
{
"version": "2025-1",
Expand All @@ -28,7 +31,8 @@
"profile": [
"vc11-sl2021/jwt"
]
}
},
"serviceId": "service-qwerty"
}
]
}
3 changes: 3 additions & 0 deletions artifacts/src/main/resources/common/protocol-version-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@
"HTTPS"
]
},
"serviceId": {
"type": "string"
},
"auth": {
"$ref": "#/definitions/Auth"
}
Expand Down
19 changes: 19 additions & 0 deletions artifacts/src/test/java/org/eclipse/dsp/schema/common/InvalidVersionSchemaTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ void verifyInvalidCases() throws IOException {
assertThat(schema.validate(INVALID_AUTH_A_STRING, JSON).iterator().next().getType()).isEqualTo(TYPE);
assertThat(schema.validate(INVALID_AUTH_MISSING_PROTOCOL, JSON).iterator().next().getType()).isEqualTo(REQUIRED);
assertThat(schema.validate(INVALID_AUTH_PROFILE_NOT_AN_ARRAY, JSON).iterator().next().getType()).isEqualTo(TYPE);
assertThat(schema.validate(INVALID_SERVICEID_NOT_A_STRING, JSON).iterator().next().getType()).isEqualTo(TYPE);
}

@BeforeEach
Expand Down Expand Up @@ -151,4 +152,22 @@ void setUp() {
]
}
""";

private static final String INVALID_SERVICEID_NOT_A_STRING = """
{
"protocolVersions": [
{
"version": "1.0",
"path": "/some/path/v1",
"binding": "HTTPS",
"auth": [{
"protocol": "some-protocol",
"version": "2",
"profile": "one-profile"
}],
"serviceId": 666
}
]
}
""";
}
10 changes: 6 additions & 4 deletions specifications/common/common.protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ endpoint should adhere to [[rfc8615]].

A [=Connector=] must respond to a respective HTTPS request by returning a [`VersionResponse`](#VersionResponse-table)
with at least one item. The item connects the version tag (`version` attribute) with a path to the endpoint.
The semantics of the `path` property are specified by each protocol binding.
The semantics of the `path` property are specified by each protocol binding. The `serviceId` is a unique id for
a [=Data Service=] and allows to group DSP-endpoints exposed by different [=Data Service=]s across versions. `binding`
describes the DSP protocol binding such as HTTPS. `auth` describes how a DSP endpoint is secured by means of the
`protocol`, `version` strings and the `profile` array.

This data object must comply to the [JSON Schema](message/schema/protocol-version-schema.json). The requesting
[=Connector=] may select from the endpoints in the response. If the [=Connector=] can't identify a matching Dataspace
Expand All @@ -38,9 +41,8 @@ discovery of all endpoints of this version. The concatenation of `<root>` and `p

The following example demonstrates that a [=Connector=] offers the HTTPS binding from version `2024-1` at
`<root>/some/path/2024-1`, the `2025-1` endpoints at `<root>/some/path/2025-1` and another [=Connector=] on the same
root URL under `<root>/different/path/2025-1` - some of which signal the relevant authentication protocol overlay,
determined by `protocol`, `version` and the `profile` array. `<root>` in the examples below is _https://provider.com_ or
_https://provider.com/path-to-root/_ respectively.
root URL under `<root>/different/path/2025-1` - some of which signal the relevant authentication protocol overlay.
`<root>` in the examples below is _https://provider.com_ or _https://provider.com/path-to-root/_ respectively.

<aside class="example" title="Well-known Version Endpoint (HTTPS) at different root path">
<pre class="http">GET https://provider.com/.well-known/dspace-version
Expand Down
Loading