Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"name": "@sap/openapi-specification",
"version": "0.14.1",
"version": "0.15.0",
"description": "SAP OpenAPI Specification for OpenAPI v2.0 (Swagger 2.0) and OpenAPI 3.0",
"author": "SAP SE",
"license": "Apache-2.0",
"main": "./dist/src/index.js",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down
8 changes: 4 additions & 4 deletions sap-schemas/v2.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Fully compiled and ready to use JSON Schema file is available [here](./schema.js
- `sap:core:v1`
- `sap:core:v2`
- Used at: [Swagger Object](https://spec.openapis.org/oas/v2.0#swagger-object) (root level)
- Description: The compliance level that this API resource is expected to be compliant with. This corresponds to the [ORD policy level](https://pages.github.tools.sap/CentralEngineering/open-resource-discovery-specification/#/v1/generated/Document?id=package_policylevel) concept.
- Description: The compliance level that this API resource is expected to be compliant with. This corresponds to the [ORD policy level](https://open-resource-discovery.github.io/specification/spec-extensions/policy-levels) concept.

Constraints:

Expand Down Expand Up @@ -192,7 +192,7 @@ Constraints:

- OPTIONAL
- MUST follow the ORD `extensible` object contract
- See [ORD Extensible Object Interface](https://pages.github.tools.sap/CentralEngineering/open-resource-discovery-specification/#/v1/generated/Document?id=extensible)
- See [ORD Extensible Object Interface](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/document#extensible)

Example:

Expand Down Expand Up @@ -230,14 +230,14 @@ Example:
### `x-sap-ord-id`

- Type: `String`
- Format: Valid [ORD ID for API Resources](https://sap.github.io/open-resource-discovery/spec-v1/interfaces/document#api-resource_ordid)
- Format: Valid [ORD ID for API Resources](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/document#api-resource_ordid)
- Used at: [Swagger Object](https://spec.openapis.org/oas/v2.0#swagger-object) (root level)
- Description: The ORD ID can be used to lookup more high-level metadata via Business Accelerator Hub or Unified Customer Landscape. It is also used when describing Integration Dependencies.

Constraints:

- OPTIONAL
- MUST be a valid [ORD ID](https://sap.github.io/open-resource-discovery/spec-v1/#ord-id) for [API Resources](https://sap.github.io/open-resource-discovery/spec-v1/interfaces/document#api-resource_ordid)
- MUST be a valid [ORD ID](https://open-resource-discovery.github.io/specification/spec-v1/#ord-id) for [API Resources](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/document#api-resource_ordid)
- Regexp: `^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource):([a-zA-Z0-9._\-]+):(v0|v[1-9][0-9]*)$`

Example:
Expand Down
8 changes: 4 additions & 4 deletions sap-schemas/v3.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Fully compiled and ready to use JSON Schema file is available [here](./schema.js
- `sap:core:v1`
- `sap:core:v2`
- Used at: [OpenAPI Object](https://spec.openapis.org/oas/v3.0.3#openapi-object) (root level)
- Description: The compliance level that this API resource is expected to be compliant with. This corresponds to the [ORD policy level](https://pages.github.tools.sap/CentralEngineering/open-resource-discovery-specification/#/v1/generated/Document?id=package_policylevel) concept.
- Description: The compliance level that this API resource is expected to be compliant with. This corresponds to the [ORD policy level](https://open-resource-discovery.github.io/specification/spec-extensions/policy-levels) concept.

Constraints:

Expand Down Expand Up @@ -144,7 +144,7 @@ Constraints:

- OPTIONAL
- MUST follow the ORD `extensible` object contract
- See [ORD Extensible Object Interface](https://pages.github.tools.sap/CentralEngineering/open-resource-discovery-specification/#/v1/generated/Document?id=extensible)
- See [ORD Extensible Object Interface](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/document#extensible)

Example:

Expand Down Expand Up @@ -182,14 +182,14 @@ Example:
### `x-sap-ord-id`

- Type: `String`
- Format: Valid [ORD ID for API Resources](https://sap.github.io/open-resource-discovery/spec-v1/interfaces/document#api-resource_ordid)
- Format: Valid [ORD ID for API Resources](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/document#api-resource_ordid)
- Used at: [OpenAPI Object](https://spec.openapis.org/oas/v3.0.3#openapi-object) (root level)
- Description: The ORD ID can be used to lookup more high-level metadata via Business Accelerator Hub or Unified Customer Landscape. It is also used when describing Integration Dependencies.

Constraints:

- OPTIONAL
- MUST be a valid [ORD ID](https://sap.github.io/open-resource-discovery/spec-v1/#ord-id) for [API Resources](https://sap.github.io/open-resource-discovery/spec-v1/interfaces/document#api-resource_ordid)
- MUST be a valid [ORD ID](https://open-resource-discovery.github.io/specification/spec-v1/#ord-id) for [API Resources](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/document#api-resource_ordid)
- Regexp: `^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource):([a-zA-Z0-9._\-]+):(v0|v[1-9][0-9]*)$`

Example:
Expand Down