Skip to content

Commit 9dca638

Browse files
authored
Update REUSE & ORD spec links (#12)
1 parent 6dc5c91 commit 9dca638

5 files changed

Lines changed: 20 additions & 16 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[![REUSE status](https://api.reuse.software/badge/github.com/open-resource-discovery/reference-application)](https://api.reuse.software/info/github.com/open-resource-discovery/reference-application)
2+
13
# Open Resource Discovery - Reference Application
24

3-
This is a reference application that demonstrates the implementation of [Open Resource Discovery](https://sap.github.io/open-resource-discovery/) (ORD) protocol.
5+
This is a reference application that demonstrates the implementation of [Open Resource Discovery](https://open-resource-discovery.github.io/specification/) (ORD) protocol.
46

57
It consists of a backend (implemented in TypeScript / Node.js) that exposes some resources (e.g. APIs and Events). Those resources are described via metadata through ORD and the applicable resource definition formats like [OpenAPI v3.0](https://spec.openapis.org/oas/v3.0.3).
68

@@ -28,7 +30,7 @@ The tenants and their configuration be found in [./src/data/user/tenants.ts](./s
2830
Some resources in the ORD Reference App are system instance aware.
2931
When fetching the metadata, we need to select for which tenant we need the information.
3032

31-
Therefore we defined custom [Access Strategies](https://sap.github.io/open-resource-discovery/spec-v1/interfaces/document#access-strategy) how the ORD information and the related metadata can be accessed.
33+
Therefore we defined custom [Access Strategies](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/document#api-resource-definition_accessstrategies) how the ORD information and the related metadata can be accessed.
3234

3335
To see some examples how the access strategies are used, have a look at [./docs/http/CRM_API.http](./docs/http/CRM_API.http) and [./docs/http/ORD_Document_API.http](./docs/http/ORD_Document_API.http).
3436
They contain documented example requests and are executable through the [REST Client VSCode Extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
@@ -93,4 +95,5 @@ If you miss some features or use case, please get in contact.
9395

9496

9597
## License
96-
Copyright (c) 2023 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file.
98+
99+
Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/open-resource-discovery/reference-application).

REUSE.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
version = 1
22
SPDX-PackageName = "open-resource-discovery-reference-application"
33
SPDX-PackageSupplier = "ospo@sap.com"
4-
SPDX-PackageDownloadLocation = "<https://github.com/sap-samples/YOUR-REPO-NAME>"
4+
SPDX-PackageDownloadLocation = "https://github.com/open-resource-discovery/reference-application"
55
SPDX-PackageComment = "The code in this project may include calls to APIs (\"API Calls\") of\n SAP or third-party products or services developed outside of this project\n (\"External Products\").\n \"APIs\" means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project's code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
66

7+
78
[[annotations]]
89
path = "**"
910
precedence = "aggregate"
10-
SPDX-FileCopyrightText = "2023 SAP SE or an SAP affiliate company and open-resource-discovery-reference-application contributors"
11+
SPDX-FileCopyrightText = "Copyright SAP SE or an SAP affiliated Company and Open Resource Discovery contributors."
1112
SPDX-License-Identifier = "Apache-2.0"

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@open-resource-discovery/specification-reference-application",
2+
"name": "@open-resource-discovery/reference-application",
33
"version": "1.1.0",
44
"description": "This is a reference application for the Open Resource Discovery protocol",
55
"type": "module",
@@ -22,7 +22,7 @@
2222
},
2323
"repository": {
2424
"type": "git",
25-
"url": "https://github.com/SAP-samples/open-resource-discovery-reference-application"
25+
"url": "https://github.com/open-resource-discovery/reference-application"
2626
},
2727
"author": "SAP SE",
2828
"dependencies": {

src/api/open-resource-discovery/v1/data/shared.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,17 @@ export const ordReferenceAppApiPackage: Package = {
5454
packageLinks: [
5555
{
5656
type: 'license',
57-
url: 'https://github.com/SAP-samples/open-resource-discovery-reference-application/blob/main/LICENSE',
57+
url: 'https://github.com/open-resource-discovery/reference-application/blob/main/LICENSE',
5858
},
5959
],
6060
links: [
6161
{
6262
title: 'ORD Reference app description',
63-
url: 'https://github.com/SAP-samples/open-resource-discovery-reference-application/blob/main/README.md',
63+
url: 'https://github.com/open-resource-discovery/reference-application/blob/main/README.md',
6464
},
6565
{
6666
title: 'ORD Reference app GitHub repository',
67-
url: 'https://github.com/SAP-samples/open-resource-discovery-reference-application/',
67+
url: 'https://github.com/open-resource-discovery/reference-application/',
6868
},
6969
],
7070
labels: {
@@ -101,7 +101,7 @@ export const basicAuthConsumptionBundle: ConsumptionBundle = {
101101
type: 'custom',
102102
customType: `${appNamespace}:basicAuthCredentialExchange:v1`,
103103
customDescription:
104-
'The BasicAuth credentials must be created and retrieved manually.\n Please refer to the documentation on the [ORD Reference App API access](https://github.com/SAP-samples/open-resource-discovery-reference-application#access-strategies).',
104+
'The BasicAuth credentials must be created and retrieved manually.\n Please refer to the documentation on the [ORD Reference App API access](https://github.com/open-resource-discovery/reference-application#access-strategies).',
105105
},
106106
],
107107
}
@@ -123,7 +123,7 @@ export const customAccessStrategyGlobalTenantId: AccessStrategy = {
123123
'The metadata information is openly accessible but system instance aware.\n' +
124124
'The tenant is selected by providing a SAP global tenant ID header.\n' +
125125
'To understand how to use this access strategy, please read the documentation on the ' +
126-
'[ORD Reference App Access Strategies](https://github.com/SAP-samples/open-resource-discovery-reference-application#access-strategies).',
126+
'[ORD Reference App Access Strategies](https://github.com/open-resource-discovery/reference-application#access-strategies).',
127127
}
128128

129129
/**
@@ -136,5 +136,5 @@ export const customAccessStrategyLocalTenantId: AccessStrategy = {
136136
'The metadata information is openly accessible but system instance aware.\n' +
137137
'The tenant is selected by providing a local tenant ID header.\n' +
138138
'To understand how to use this access strategy, please read the documentation on the ' +
139-
'[ORD Reference App Access Strategies](https://github.com/SAP-samples/open-resource-discovery-reference-application#access-strategies).',
139+
'[ORD Reference App Access Strategies](https://github.com/open-resource-discovery/reference-application#access-strategies).',
140140
}

static/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ <h1 class="title">
4949
ORD Reference App
5050
</h1>
5151
<p class="subtitle">
52-
Example application for <a href="https://sap.github.io/open-resource-discovery/">Open Resource
52+
Example application for <a href="https://open-resource-discovery.github.io/specification/">Open Resource
5353
Discovery</a> (ORD).
54-
Source Code: <a href="https://github.com/SAP-samples/open-resource-discovery-reference-application/">
55-
github.com/SAP-samples</a>.
54+
Source Code: <a
55+
href="https://github.com/open-resource-discovery/reference-application/">github.com/open-resource-discovery/reference-application/</a>.
5656
</p>
5757
</div>
5858
<br />

0 commit comments

Comments
 (0)