From f4a7d5ca33bb663f2ba210d2533ca7e96733e729 Mon Sep 17 00:00:00 2001 From: Paul Latzelsperger <43503240+paullatzelsperger@users.noreply.github.com> Date: Wed, 19 Jul 2023 11:39:13 +0200 Subject: [PATCH] chore: remove OpenApi check in CI (#3314) * chore: remove OpenApi check in CI * remove pullrequest trigger --- .github/workflows/apidoc.yaml | 53 +- .../yaml/control-api/control-plane-api.yaml | 82 -- .../yaml/control-api/data-plane-api.yaml | 157 ---- .../yaml/control-api/transfer-data-plane.yaml | 35 - .../management-api/api-observability.yaml | 97 --- .../yaml/management-api/asset-api.yaml | 714 ------------------ .../yaml/management-api/catalog-api.yaml | 186 ----- .../contract-agreement-api.yaml | 259 ------- .../contract-definition-api.yaml | 382 ---------- .../contract-negotiation-api.yaml | 634 ---------------- .../data-plane-selector-api.yaml | 110 --- .../management-api/policy-definition-api.yaml | 412 ---------- .../yaml/management-api/provision-http.yaml | 95 --- .../management-api/transfer-process-api.yaml | 580 -------------- 14 files changed, 3 insertions(+), 3793 deletions(-) delete mode 100644 resources/openapi/yaml/control-api/control-plane-api.yaml delete mode 100644 resources/openapi/yaml/control-api/data-plane-api.yaml delete mode 100644 resources/openapi/yaml/control-api/transfer-data-plane.yaml delete mode 100644 resources/openapi/yaml/management-api/api-observability.yaml delete mode 100644 resources/openapi/yaml/management-api/asset-api.yaml delete mode 100644 resources/openapi/yaml/management-api/catalog-api.yaml delete mode 100644 resources/openapi/yaml/management-api/contract-agreement-api.yaml delete mode 100644 resources/openapi/yaml/management-api/contract-definition-api.yaml delete mode 100644 resources/openapi/yaml/management-api/contract-negotiation-api.yaml delete mode 100644 resources/openapi/yaml/management-api/data-plane-selector-api.yaml delete mode 100644 resources/openapi/yaml/management-api/policy-definition-api.yaml delete mode 100644 resources/openapi/yaml/management-api/provision-http.yaml delete mode 100644 resources/openapi/yaml/management-api/transfer-process-api.yaml diff --git a/.github/workflows/apidoc.yaml b/.github/workflows/apidoc.yaml index 42635cabac0..3ab213e4307 100644 --- a/.github/workflows/apidoc.yaml +++ b/.github/workflows/apidoc.yaml @@ -9,64 +9,16 @@ on: type: string push: - pull_request: - branches: [ main ] - paths-ignore: - - '**.md' - - 'docs/**' - - 'CODEOWNERS' - - 'LICENSE' concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: - Verify-OpenAPI-Definitions: - runs-on: ubuntu-latest - strategy: - fail-fast: true - matrix: - apiGroup: [ 'management-api', 'control-api' ] - env: - rootDir: resources/openapi/yaml/${{ matrix.apiGroup }} - steps: - - uses: actions/checkout@v3 - - uses: ./.github/actions/setup-build - - - name: Save previous OpenAPI definition - run: | - mkdir -p git-sorted/${{ matrix.apiGroup }} - files=($(ls $rootDir)) - for file in ${files[@]}; do - yq -P 'sort_keys(..)' $rootDir/$file > git-sorted/${{ matrix.apiGroup }}/$file - done - - - name: Generate OpenAPI definitions from code - run: | - export - ./gradlew resolve - - # Can be used (and yq tasks removed) when https://github.com/kpramesh2212/openapi-merger-plugin/pull/11/files is merged - #- name: Check OpenAPI definitions match code - # run: git diff --exit-code - - - name: Check OpenAPI definitions match code - run: | - mkdir -p git-regen/${{ matrix.apiGroup }} - files=($(ls resources/openapi/yaml/${{ matrix.apiGroup}})) - - for file in ${files[@]}; do - yq -P 'sort_keys(..)' $rootDir/$file > git-regen/${{ matrix.apiGroup }}/$file - done - - diff -r git-sorted git-regen - Publish-To-SwaggerHub: - # do NOT run on forks or on PRs. The Org ("edc") is unique all across SwaggerHub - if: github.repository == 'eclipse-edc/Connector' && github.event_name != 'pull_request' + # do NOT run on forks. The Org ("edc") is unique all across SwaggerHub + if: github.repository == 'eclipse-edc/Connector' runs-on: ubuntu-latest - needs: [ Verify-OpenAPI-Definitions ] strategy: matrix: apiGroup: [ 'management-api', 'control-api' ] @@ -88,6 +40,7 @@ jobs: if [ ! -z $VERSION ]; then cmd="-Pversion=$VERSION" fi + ./gradlew resolve ./gradlew ${cmd} -PapiTitle="${{ matrix.apiGroup }}" -PapiDescription="REST API documentation for the ${{ matrix.apiGroup }}" :mergeApiSpec --input=${{ env.rootDir }} --output=${{ matrix.apiGroup }}.yaml # install swaggerhub CLI diff --git a/resources/openapi/yaml/control-api/control-plane-api.yaml b/resources/openapi/yaml/control-api/control-plane-api.yaml deleted file mode 100644 index 129d3306a9a..00000000000 --- a/resources/openapi/yaml/control-api/control-plane-api.yaml +++ /dev/null @@ -1,82 +0,0 @@ -openapi: 3.0.1 -paths: - /transferprocess/{processId}/complete: - post: - description: "Requests completion of the transfer process. Due to the asynchronous\ - \ nature of transfers, a successful response only indicates that the request\ - \ was successfully received" - operationId: complete - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - responses: - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - tags: - - Transfer Process Control Api - /transferprocess/{processId}/fail: - post: - description: "Requests completion of the transfer process. Due to the asynchronous\ - \ nature of transfers, a successful response only indicates that the request\ - \ was successfully received" - operationId: fail - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TransferProcessFailStateDto' - responses: - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - tags: - - Transfer Process Control Api -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: object - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - TransferProcessFailStateDto: - type: object - example: null - properties: - errorMessage: - type: string - example: null diff --git a/resources/openapi/yaml/control-api/data-plane-api.yaml b/resources/openapi/yaml/control-api/data-plane-api.yaml deleted file mode 100644 index 74d5b839470..00000000000 --- a/resources/openapi/yaml/control-api/data-plane-api.yaml +++ /dev/null @@ -1,157 +0,0 @@ -openapi: 3.0.1 -tags: -- description: 'Api targeted by the Control Plane to delegate a data transfer (Provider - Push or Streaming) to the Data Plane after the contract has been successfully - negotiated and agreed between the two participants. ' - name: Data Plane control API -- description: "The public API of the Data Plane is a data proxy enabling a data consumer\ - \ to actively querydata from the provider data source (e.g. backend Rest API,\ - \ internal database...) through its Data Planeinstance. Thus the Data Plane is\ - \ the only entry/output door for the data, which avoids the provider to exposedirectly\ - \ its data externally.The Data Plane public API being a proxy, it supports all\ - \ verbs (i.e. GET, POST, PUT, PATCH, DELETE), whichcan then conveyed until the\ - \ data source is required. This is especially useful when the actual data sourceis\ - \ a Rest API itself.In the same manner, any set of arbitrary query parameters,\ - \ path parameters and request body are supported (in the limits fixed by the HTTP\ - \ server) and can also conveyed to the actual data source." - name: Data Plane public API -paths: - /transfer: - post: - description: Initiates a data transfer for the given request. The transfer will - be performed asynchronously. - operationId: initiateTransfer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataFlowRequest' - responses: - "200": - description: Data transfer initiated - "400": - description: Failed to validate request - tags: - - Data Plane control API - /transfer/{processId}: - get: - description: Get the current state of a data transfer. - operationId: getTransferState - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - responses: - "200": - description: Missing access token - tags: - - Data Plane control API - /{any}: - delete: - description: Send `DELETE` data query to the Data Plane. - operationId: delete - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - get: - description: Send `GET` data query to the Data Plane. - operationId: get - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - patch: - description: Send `PATCH` data query to the Data Plane. - operationId: patch - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - post: - description: Send `POST` data query to the Data Plane. - operationId: post - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - put: - description: Send `PUT` data query to the Data Plane. - operationId: put - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DataFlowRequest: - type: object - example: null - properties: - callbackAddress: - type: string - format: url - example: null - destinationDataAddress: - $ref: '#/components/schemas/DataAddress' - id: - type: string - example: null - processId: - type: string - example: null - properties: - type: object - additionalProperties: - type: string - example: null - example: null - sourceDataAddress: - $ref: '#/components/schemas/DataAddress' - traceContext: - type: object - additionalProperties: - type: string - example: null - example: null - trackable: - type: boolean - example: null diff --git a/resources/openapi/yaml/control-api/transfer-data-plane.yaml b/resources/openapi/yaml/control-api/transfer-data-plane.yaml deleted file mode 100644 index ab3cca212c5..00000000000 --- a/resources/openapi/yaml/control-api/transfer-data-plane.yaml +++ /dev/null @@ -1,35 +0,0 @@ -openapi: 3.0.1 -paths: - /token: - get: - description: "Checks that the provided token has been signed by the present\ - \ entity and asserts its validity. If token is valid, then the data address\ - \ contained in its claims is decrypted and returned back to the caller." - operationId: validate - parameters: - - in: header - name: Authorization - schema: - type: string - example: null - responses: - "200": - description: Token is valid - "400": - description: Request was malformed - "403": - description: Token is invalid - tags: - - Consumer Pull Token Validation -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null diff --git a/resources/openapi/yaml/management-api/api-observability.yaml b/resources/openapi/yaml/management-api/api-observability.yaml deleted file mode 100644 index 62976214772..00000000000 --- a/resources/openapi/yaml/management-api/api-observability.yaml +++ /dev/null @@ -1,97 +0,0 @@ -openapi: 3.0.1 -paths: - /check/health: - get: - description: Performs a liveness probe to determine whether the runtime is working - properly. - operationId: checkHealth - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HealthStatus' - description: The runtime is working properly. - tags: - - Application Observability - /check/liveness: - get: - description: Performs a liveness probe to determine whether the runtime is working - properly. - operationId: getLiveness - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HealthStatus' - description: The runtime is working properly. - tags: - - Application Observability - /check/readiness: - get: - description: Performs a readiness probe to determine whether the runtime is - able to accept requests. - operationId: getReadiness - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HealthStatus' - description: The runtime is able to accept requests. - tags: - - Application Observability - /check/startup: - get: - description: Performs a startup probe to determine whether the runtime has completed - startup. - operationId: getStartup - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HealthStatus' - description: The runtime has completed startup. - tags: - - Application Observability -components: - schemas: - Failure: - type: object - example: null - properties: - failureDetail: - type: string - example: null - messages: - type: array - example: null - items: - type: string - example: null - HealthCheckResult: - type: object - example: null - properties: - component: - type: string - example: null - failure: - $ref: '#/components/schemas/Failure' - isHealthy: - type: boolean - example: null - HealthStatus: - type: object - example: null - properties: - componentResults: - type: array - example: null - items: - $ref: '#/components/schemas/HealthCheckResult' - isSystemHealthy: - type: boolean - example: null diff --git a/resources/openapi/yaml/management-api/asset-api.yaml b/resources/openapi/yaml/management-api/asset-api.yaml deleted file mode 100644 index 35a2d52b602..00000000000 --- a/resources/openapi/yaml/management-api/asset-api.yaml +++ /dev/null @@ -1,714 +0,0 @@ -openapi: 3.0.1 -info: - description: "This contains both the current and the new Asset API, which accepts\ - \ JSON-LD and will become the standard API once the Dataspace Protocol is stable.\ - \ The new Asset API is prefixed with /v2, and the old endpoints have been deprecated.\ - \ At that time of switching, the old API will be removed, and this API will be\ - \ available without the /v2 prefix." - title: Asset API -paths: - /v2/assets: - post: - deprecated: true - description: Creates a new asset together with a data address - operationId: createAsset - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AssetEntryNewDto' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponse' - description: Asset was created successfully. Returns the asset Id and created - timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create asset, because an asset with that ID already\ - \ exists" - tags: - - Asset - put: - deprecated: true - description: "Updates an asset with the given ID if it exists. If the asset\ - \ is not found, no further action is taken. DANGER ZONE: Note that updating\ - \ assets can have unexpected results, especially for contract offers that\ - \ have been sent out or are ongoing in contract negotiations." - operationId: updateAsset - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Asset' - responses: - "200": - description: Asset was updated successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - description: "Asset could not be updated, because it does not exist." - tags: - - Asset - /v2/assets/request: - post: - deprecated: true - description: ' all assets according to a particular query' - operationId: requestAssets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpec' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/Asset' - description: The assets matching the query - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Asset - /v2/assets/{assetId}/dataaddress: - put: - deprecated: true - description: Updates a DataAddress for an asset with the given ID. - operationId: updateDataAddress - parameters: - - in: path - name: assetId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Asset' - responses: - "200": - description: Asset was updated successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - tags: - - Asset - /v2/assets/{id}: - delete: - deprecated: true - description: "Removes an asset with the given ID if possible. Deleting an asset\ - \ is only possible if that asset is not yet referenced by a contract agreement,\ - \ in which case an error is returned. DANGER ZONE: Note that deleting assets\ - \ can have unexpected results, especially for contract offers that have been\ - \ sent out or ongoing or contract negotiations." - operationId: removeAsset - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Asset was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "The asset cannot be deleted, because it is referenced by a\ - \ contract agreement" - tags: - - Asset - get: - deprecated: true - description: Gets an asset with the given ID - operationId: getAsset - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Asset' - description: The asset - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - tags: - - Asset - /v2/assets/{id}/dataaddress: - get: - deprecated: true - description: Gets a data address of an asset with the given ID - operationId: getAssetDataAddress - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DataAddress' - description: The data address - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - tags: - - Asset - /v3/assets: - post: - description: Creates a new asset together with a data address - operationId: createAsset_1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AssetInput' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponse' - description: Asset was created successfully. Returns the asset Id and created - timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create asset, because an asset with that ID already\ - \ exists" - tags: - - Asset - put: - description: "Updates an asset with the given ID if it exists. If the asset\ - \ is not found, no further action is taken. DANGER ZONE: Note that updating\ - \ assets can have unexpected results, especially for contract offers that\ - \ have been sent out or are ongoing in contract negotiations." - operationId: updateAsset_1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AssetInput' - responses: - "200": - description: Asset was updated successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - description: "Asset could not be updated, because it does not exist." - tags: - - Asset - /v3/assets/request: - post: - description: ' all assets according to a particular query' - operationId: requestAssets_1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpec' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/AssetOutput' - description: The assets matching the query - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Asset - /v3/assets/{id}: - delete: - description: "Removes an asset with the given ID if possible. Deleting an asset\ - \ is only possible if that asset is not yet referenced by a contract agreement,\ - \ in which case an error is returned. DANGER ZONE: Note that deleting assets\ - \ can have unexpected results, especially for contract offers that have been\ - \ sent out or ongoing or contract negotiations." - operationId: removeAsset_1 - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Asset was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "The asset cannot be deleted, because it is referenced by a\ - \ contract agreement" - tags: - - Asset - get: - description: Gets an asset with the given ID - operationId: getAsset_1 - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AssetOutput' - description: The asset - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - tags: - - Asset -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: object - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - Asset: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - dataAddress: - $ref: '#/components/schemas/DataAddress' - id: - type: string - example: null - privateProperties: - type: object - additionalProperties: - type: object - example: null - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - AssetEntryNewDto: - type: object - example: null - properties: - asset: - $ref: '#/components/schemas/Asset' - dataAddress: - $ref: '#/components/schemas/DataAddress' - AssetInput: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': definition-id - properties: - key: value - privateProperties: - privateKey: privateValue - dataAddress: - type: HttpData - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Asset - dataAddress: - $ref: '#/components/schemas/DataAddress' - privateProperties: - type: object - additionalProperties: - type: object - example: null - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - AssetOutput: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': definition-id - edc:properties: - edc:key: value - edc:privateProperties: - edc:privateKey: privateValue - edc:dataAddress: - edc:type: HttpData - edc:createdAt: 1688465655 - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Asset - createdAt: - type: integer - format: int64 - example: null - dataAddress: - $ref: '#/components/schemas/DataAddress' - privateProperties: - type: object - additionalProperties: - type: object - example: null - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - Criterion: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': Criterion - operandLeft: fieldName - operator: = - operandRight: some value - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Criterion - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - DataAddress: - type: object - example: null - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/DataAddress - type: - type: string - example: null - IdResponse: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': id-value - createdAt: 1688465655 - properties: - '@id': - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - JsonArray: - type: array - example: null - items: - $ref: '#/components/schemas/JsonValue' - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - QuerySpec: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': QuerySpec - offset: 5 - limit: 10 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/QuerySpec - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/resources/openapi/yaml/management-api/catalog-api.yaml b/resources/openapi/yaml/management-api/catalog-api.yaml deleted file mode 100644 index f5b766a89b5..00000000000 --- a/resources/openapi/yaml/management-api/catalog-api.yaml +++ /dev/null @@ -1,186 +0,0 @@ -openapi: 3.0.1 -paths: - /v2/catalog/request: - post: - operationId: requestCatalog - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CatalogRequest' - responses: - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Catalog' - description: Gets contract offers (=catalog) of a single connector - tags: - - Catalog -components: - schemas: - Catalog: - type: object - description: DCAT catalog - example: - '@id': 7df65569-8c59-4013-b1c0-fa14f6641bf2 - '@type': dcat:Catalog - dcat:dataset: - '@id': bcca61be-e82e-4da6-bfec-9716a56cef35 - '@type': dcat:Dataset - odrl:hasPolicy: - '@id': OGU0ZTMzMGMtODQ2ZS00ZWMxLThmOGQtNWQxNWM0NmI2NmY4:YmNjYTYxYmUtZTgyZS00ZGE2LWJmZWMtOTcxNmE1NmNlZjM1:NDY2ZTZhMmEtNjQ1Yy00ZGQ0LWFlZDktMjdjNGJkZTU4MDNj - '@type': odrl:Set - odrl:permission: - odrl:target: bcca61be-e82e-4da6-bfec-9716a56cef35 - odrl:action: - odrl:type: http://www.w3.org/ns/odrl/2/use - odrl:constraint: - odrl:and: - - odrl:leftOperand: https://w3id.org/edc/v0.0.1/ns/inForceDate - odrl:operator: - '@id': odrl:gteq - odrl:rightOperand: 2023-07-07T07:19:58.585601395Z - - odrl:leftOperand: https://w3id.org/edc/v0.0.1/ns/inForceDate - odrl:operator: - '@id': odrl:lteq - odrl:rightOperand: 2023-07-12T07:19:58.585601395Z - odrl:prohibition: [] - odrl:obligation: [] - odrl:target: bcca61be-e82e-4da6-bfec-9716a56cef35 - dcat:distribution: - - '@type': dcat:Distribution - dct:format: - '@id': HttpData - dcat:accessService: 5e839777-d93e-4785-8972-1005f51cf367 - edc:description: description - edc:id: bcca61be-e82e-4da6-bfec-9716a56cef35 - dcat:service: - '@id': 5e839777-d93e-4785-8972-1005f51cf367 - '@type': dcat:DataService - dct:terms: connector - dct:endpointUrl: http://localhost:16806/protocol - edc:participantId: urn:connector:provider - '@context': - dct: https://purl.org/dc/terms/ - edc: https://w3id.org/edc/v0.0.1/ns/ - dcat: https://www.w3.org/ns/dcat/ - odrl: http://www.w3.org/ns/odrl/2/ - dspace: https://w3id.org/dspace/v0.8/ - CatalogRequest: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': CatalogRequest - providerUrl: http://provider-address - protocol: dataspace-protocol-http - querySpec: - offset: 0 - limit: 50 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/CatalogRequest - protocol: - type: string - example: null - querySpec: - $ref: '#/components/schemas/QuerySpec' - Criterion: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': Criterion - operandLeft: fieldName - operator: = - operandRight: some value - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Criterion - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - QuerySpec: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': QuerySpec - offset: 5 - limit: 10 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/QuerySpec - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/resources/openapi/yaml/management-api/contract-agreement-api.yaml b/resources/openapi/yaml/management-api/contract-agreement-api.yaml deleted file mode 100644 index 59cd2a7cba2..00000000000 --- a/resources/openapi/yaml/management-api/contract-agreement-api.yaml +++ /dev/null @@ -1,259 +0,0 @@ -openapi: 3.0.1 -paths: - /v2/contractagreements/request: - post: - description: Gets all contract agreements according to a particular query - operationId: queryAllAgreements - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/QuerySpec' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractAgreement' - description: The contract agreements matching the query - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Contract Agreement - /v2/contractagreements/{id}: - get: - description: Gets an contract agreement with the given ID - operationId: getAgreementById - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractAgreement' - description: The contract agreement - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract agreement with the given ID does not exist - tags: - - Contract Agreement -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: object - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - ContractAgreement: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/ContractAgreement - '@id': negotiation-id - providerId: provider-id - consumerId: consumer-id - assetId: asset-id - contractSigningDate: 1688465655 - policy: - '@context': http://www.w3.org/ns/odrl.jsonld - '@type': Set - '@id': offer-id - permission: - - target: asset-id - action: display - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/ContractAgreement - assetId: - type: string - example: null - consumerId: - type: string - example: null - contractSigningDate: - type: integer - format: int64 - example: null - policy: - $ref: '#/components/schemas/Policy' - providerId: - type: string - example: null - Criterion: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': Criterion - operandLeft: fieldName - operator: = - operandRight: some value - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Criterion - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - JsonArray: - type: array - example: null - items: - $ref: '#/components/schemas/JsonValue' - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - Policy: - type: object - description: ODRL policy - example: - '@context': http://www.w3.org/ns/odrl.jsonld - '@id': 0949ba30-680c-44e6-bc7d-1688cbe1847e - '@type': odrl:Set - permission: - target: http://example.com/asset:9898.movie - action: - type: http://www.w3.org/ns/odrl/2/use - constraint: - leftOperand: https://w3id.org/edc/v0.0.1/ns/left - operator: eq - rightOperand: value - prohibition: [] - obligation: [] - QuerySpec: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': QuerySpec - offset: 5 - limit: 10 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/QuerySpec - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/resources/openapi/yaml/management-api/contract-definition-api.yaml b/resources/openapi/yaml/management-api/contract-definition-api.yaml deleted file mode 100644 index e3c321b9fff..00000000000 --- a/resources/openapi/yaml/management-api/contract-definition-api.yaml +++ /dev/null @@ -1,382 +0,0 @@ -openapi: 3.0.1 -paths: - /v2/contractdefinitions: - post: - description: Creates a new contract definition - operationId: createContractDefinition - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/ContractDefinitionInput' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponse' - description: contract definition was created successfully. Returns the Contract - Definition Id and created timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create contract definition, because a contract definition\ - \ with that ID already exists" - tags: - - Contract Definition - put: - description: Updated a contract definition with the given ID. The supplied JSON - structure must be a valid JSON-LD object - operationId: updateContractDefinition - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/ContractDefinitionInput' - responses: - "204": - description: Contract definition was updated successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract definition with the given ID does not exist - tags: - - Contract Definition - /v2/contractdefinitions/request: - post: - description: Returns all contract definitions according to a query - operationId: queryAllContractDefinitions - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/QuerySpec' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractDefinitionOutput' - description: The contract definitions matching the query - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Contract Definition - /v2/contractdefinitions/{id}: - delete: - description: "Removes a contract definition with the given ID if possible. DANGER\ - \ ZONE: Note that deleting contract definitions can have unexpected results,\ - \ especially for contract offers that have been sent out or ongoing or contract\ - \ negotiations." - operationId: deleteContractDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Contract definition was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract definition with the given ID does not exist - tags: - - Contract Definition - get: - description: Gets an contract definition with the given ID - operationId: getContractDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractDefinitionOutput' - description: The contract definition - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract agreement with the given ID does not exist - tags: - - Contract Definition -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: object - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - ContractDefinitionInput: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': definition-id - accessPolicyId: asset-policy-id - contractPolicyId: contract-policy-id - assetsSelector: [] - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/ContractDefinition - accessPolicyId: - type: string - example: null - assetsSelector: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - contractPolicyId: - type: string - example: null - ContractDefinitionOutput: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': definition-id - edc:accessPolicyId: asset-policy-id - edc:contractPolicyId: contract-policy-id - edc:assetsSelector: [] - edc:createdAt: 1688465655 - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/ContractDefinition - accessPolicyId: - type: string - example: null - assetsSelector: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - contractPolicyId: - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - Criterion: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': Criterion - operandLeft: fieldName - operator: = - operandRight: some value - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Criterion - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - IdResponse: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': id-value - createdAt: 1688465655 - properties: - '@id': - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - JsonArray: - type: array - example: null - items: - $ref: '#/components/schemas/JsonValue' - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - QuerySpec: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': QuerySpec - offset: 5 - limit: 10 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/QuerySpec - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/resources/openapi/yaml/management-api/contract-negotiation-api.yaml b/resources/openapi/yaml/management-api/contract-negotiation-api.yaml deleted file mode 100644 index 87bddeed37e..00000000000 --- a/resources/openapi/yaml/management-api/contract-negotiation-api.yaml +++ /dev/null @@ -1,634 +0,0 @@ -openapi: 3.0.1 -paths: - /v2/contractnegotiations: - post: - description: "Initiates a contract negotiation for a given offer and with the\ - \ given counter part. Please note that successfully invoking this endpoint\ - \ only means that the negotiation was initiated. Clients must poll the /{id}/state\ - \ endpoint to track the state" - operationId: initiateContractNegotiation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ContractRequest' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponse' - description: The negotiation was successfully initiated. Returns the contract - negotiation ID and created timestamp - links: - poll-state: - operationId: getNegotiationState - parameters: - id: $response.body#/id - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Contract Negotiation - /v2/contractnegotiations/request: - post: - description: Returns all contract negotiations according to a query - operationId: queryNegotiations - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpec' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractNegotiation' - description: The contract negotiations that match the query - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Contract Negotiation - /v2/contractnegotiations/{id}: - get: - description: Gets a contract negotiation with the given ID - operationId: getNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractNegotiation' - description: The contract negotiation - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /v2/contractnegotiations/{id}/agreement: - get: - description: Gets a contract agreement for a contract negotiation with the given - ID - operationId: getAgreementForNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractAgreement' - description: "The contract agreement that is attached to the negotiation,\ - \ or null" - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /v2/contractnegotiations/{id}/cancel: - post: - description: "Requests aborting the contract negotiation. Due to the asynchronous\ - \ nature of contract negotiations, a successful response only indicates that\ - \ the request was successfully received. Clients must poll the /{id}/state\ - \ endpoint to track the state." - operationId: cancelNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Request to cancel the Contract negotiation was successfully - received - links: - poll-state: - operationId: getNegotiationState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /v2/contractnegotiations/{id}/decline: - post: - description: "Requests cancelling the contract negotiation. Due to the asynchronous\ - \ nature of contract negotiations, a successful response only indicates that\ - \ the request was successfully received. Clients must poll the /{id}/state\ - \ endpoint to track the state." - operationId: declineNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Request to decline the Contract negotiation was successfully - received - links: - poll-state: - operationId: getNegotiationState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /v2/contractnegotiations/{id}/state: - get: - description: Gets the state of a contract negotiation with the given ID - operationId: getNegotiationState - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NegotiationState' - description: The contract negotiation's state - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract negotiation with the given ID does not exist - tags: - - Contract Negotiation -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: object - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - CallbackAddress: - type: object - example: null - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/CallbackAddress - authCodeId: - type: string - example: null - authKey: - type: string - example: null - events: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - transactional: - type: boolean - example: null - uri: - type: string - example: null - ContractAgreement: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/ContractAgreement - '@id': negotiation-id - providerId: provider-id - consumerId: consumer-id - assetId: asset-id - contractSigningDate: 1688465655 - policy: - '@context': http://www.w3.org/ns/odrl.jsonld - '@type': Set - '@id': offer-id - permission: - - target: asset-id - action: display - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/ContractAgreement - assetId: - type: string - example: null - consumerId: - type: string - example: null - contractSigningDate: - type: integer - format: int64 - example: null - policy: - $ref: '#/components/schemas/Policy' - providerId: - type: string - example: null - ContractNegotiation: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/ContractNegotiation - '@id': negotiation-id - type: PROVIDER - protocol: dataspace-protocol-http - counterPartyId: counter-party-id - counterPartyAddress: http://counter/party/address - state: VERIFIED - contractAgreementId: contract:agreement:id - errorDetail: eventual-error-detail - createdAt: 1688465655 - callbackAddresses: - - transactional: false - uri: http://callback/url - events: - - contract.negotiation - - transfer.process - authKey: auth-key - authCodeId: auth-code-id - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/ContractNegotiation - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddress' - contractAgreementId: - type: string - example: null - counterPartyAddress: - type: string - example: null - counterPartyId: - type: string - example: null - errorDetail: - type: string - example: null - protocol: - type: string - example: null - state: - type: string - example: null - type: - type: string - enum: - - CONSUMER - - PROVIDER - example: null - ContractOfferDescription: - type: object - example: null - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/ContractOfferDescription - assetId: - type: string - example: null - offerId: - type: string - example: null - policy: - $ref: '#/components/schemas/Policy' - ContractRequest: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/ContractRequest - connectorAddress: http://provider-address - protocol: dataspace-protocol-http - providerId: provider-id - offer: - offerId: offer-id - assetId: asset-id - policy: - '@context': http://www.w3.org/ns/odrl.jsonld - '@type': Set - '@id': offer-id - permission: - - target: asset-id - action: display - callbackAddresses: - - transactional: false - uri: http://callback/url - events: - - contract.negotiation - - transfer.process - authKey: auth-key - authCodeId: auth-code-id - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/ContractRequest - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddress' - connectorAddress: - type: string - example: null - connectorId: - type: string - deprecated: true - description: please use providerId instead - example: null - consumerId: - type: string - deprecated: true - description: this field is not used anymore - example: null - offer: - $ref: '#/components/schemas/ContractOfferDescription' - protocol: - type: string - example: null - providerId: - type: string - example: null - Criterion: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': Criterion - operandLeft: fieldName - operator: = - operandRight: some value - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Criterion - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - IdResponse: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': id-value - createdAt: 1688465655 - properties: - '@id': - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - JsonArray: - type: array - example: null - items: - $ref: '#/components/schemas/JsonValue' - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - NegotiationState: - type: object - example: null - properties: - state: - type: string - example: null - Policy: - type: object - description: ODRL policy - example: - '@context': http://www.w3.org/ns/odrl.jsonld - '@id': 0949ba30-680c-44e6-bc7d-1688cbe1847e - '@type': odrl:Set - permission: - target: http://example.com/asset:9898.movie - action: - type: http://www.w3.org/ns/odrl/2/use - constraint: - leftOperand: https://w3id.org/edc/v0.0.1/ns/left - operator: eq - rightOperand: value - prohibition: [] - obligation: [] - QuerySpec: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': QuerySpec - offset: 5 - limit: 10 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/QuerySpec - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/resources/openapi/yaml/management-api/data-plane-selector-api.yaml b/resources/openapi/yaml/management-api/data-plane-selector-api.yaml deleted file mode 100644 index 7f68fe64f37..00000000000 --- a/resources/openapi/yaml/management-api/data-plane-selector-api.yaml +++ /dev/null @@ -1,110 +0,0 @@ -openapi: 3.0.1 -paths: - /instances: - get: - operationId: getAll - responses: - default: - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/DataPlaneInstance' - description: default response - tags: - - Dataplane Selector - post: - operationId: addEntry - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataPlaneInstance' - responses: - default: - content: - application/json: {} - description: default response - tags: - - Dataplane Selector - /instances/select: - post: - operationId: find - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SelectionRequest' - responses: - default: - content: - application/json: - schema: - $ref: '#/components/schemas/DataPlaneInstance' - description: default response - tags: - - Dataplane Selector -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DataPlaneInstance: - type: object - example: null - properties: - allowedDestTypes: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - allowedSourceTypes: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - id: - type: string - example: null - lastActive: - type: integer - format: int64 - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - turnCount: - type: integer - format: int32 - example: null - url: - type: string - format: url - example: null - SelectionRequest: - type: object - example: null - properties: - destination: - $ref: '#/components/schemas/DataAddress' - source: - $ref: '#/components/schemas/DataAddress' - strategy: - type: string - example: null diff --git a/resources/openapi/yaml/management-api/policy-definition-api.yaml b/resources/openapi/yaml/management-api/policy-definition-api.yaml deleted file mode 100644 index dfb4f60a578..00000000000 --- a/resources/openapi/yaml/management-api/policy-definition-api.yaml +++ /dev/null @@ -1,412 +0,0 @@ -openapi: 3.0.1 -paths: - /v2/policydefinitions: - post: - description: Creates a new policy definition - operationId: createPolicyDefinition - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionInput' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponse' - description: policy definition was created successfully. Returns the Policy - Definition Id and created timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create policy definition, because a contract definition\ - \ with that ID already exists" - tags: - - Policy Definition - /v2/policydefinitions/request: - post: - description: Returns all policy definitions according to a query - operationId: queryPolicyDefinitions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpec' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/PolicyDefinitionOutput' - description: The policy definitions matching the query - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Policy Definition - /v2/policydefinitions/{id}: - delete: - description: "Removes a policy definition with the given ID if possible. Deleting\ - \ a policy definition is only possible if that policy definition is not yet\ - \ referenced by a contract definition, in which case an error is returned.\ - \ DANGER ZONE: Note that deleting policy definitions can have unexpected results,\ - \ do this at your own risk!" - operationId: deletePolicyDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Policy definition was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An policy definition with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "The policy definition cannot be deleted, because it is referenced\ - \ by a contract definition" - tags: - - Policy Definition - get: - description: Gets a policy definition with the given ID - operationId: getPolicyDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionOutput' - description: The policy definition - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An policy definition with the given ID does not exist - tags: - - Policy Definition - put: - description: "Updates an existing Policy, If the Policy is not found, an error\ - \ is reported" - operationId: updatePolicyDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionInput' - responses: - "200": - description: policy definition was updated successfully. Returns the Policy - Definition Id and updated timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDetail' - description: "policy definition could not be updated, because it does not\ - \ exists" - tags: - - Policy Definition -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: object - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - Criterion: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': Criterion - operandLeft: fieldName - operator: = - operandRight: some value - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Criterion - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - IdResponse: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': id-value - createdAt: 1688465655 - properties: - '@id': - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - JsonArray: - type: array - example: null - items: - $ref: '#/components/schemas/JsonValue' - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - Policy: - type: object - description: ODRL policy - example: - '@context': http://www.w3.org/ns/odrl.jsonld - '@id': 0949ba30-680c-44e6-bc7d-1688cbe1847e - '@type': odrl:Set - permission: - target: http://example.com/asset:9898.movie - action: - type: http://www.w3.org/ns/odrl/2/use - constraint: - leftOperand: https://w3id.org/edc/v0.0.1/ns/left - operator: eq - rightOperand: value - prohibition: [] - obligation: [] - PolicyDefinitionInput: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': definition-id - policy: - '@context': http://www.w3.org/ns/odrl.jsonld - '@type': Set - uid: http://example.com/policy:1010 - permission: - - target: http://example.com/asset:9898.movie - action: display - constraint: - - leftOperand: spatial - operator: eq - rightOperand: https://www.wikidata.org/wiki/Q183 - comment: i.e Germany - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/PolicyDefinition - policy: - $ref: '#/components/schemas/Policy' - PolicyDefinitionOutput: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': definition-id - policy: - '@context': http://www.w3.org/ns/odrl.jsonld - '@type': Set - uid: http://example.com/policy:1010 - permission: - - target: http://example.com/asset:9898.movie - action: display - constraint: - - leftOperand: spatial - operator: eq - rightOperand: https://www.wikidata.org/wiki/Q183 - comment: i.e Germany - createdAt: 1688465655 - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/PolicyDefinition - policy: - $ref: '#/components/schemas/Policy' - QuerySpec: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': QuerySpec - offset: 5 - limit: 10 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/QuerySpec - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/resources/openapi/yaml/management-api/provision-http.yaml b/resources/openapi/yaml/management-api/provision-http.yaml deleted file mode 100644 index ae8e8710364..00000000000 --- a/resources/openapi/yaml/management-api/provision-http.yaml +++ /dev/null @@ -1,95 +0,0 @@ -openapi: 3.0.1 -paths: - /callback/{processId}/deprovision: - post: - operationId: callDeprovisionWebhook - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeprovisionedResource' - responses: - default: - content: - application/json: {} - description: default response - tags: - - HTTP Provisioner Webhook - /callback/{processId}/provision: - post: - operationId: callProvisionWebhook - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProvisionerWebhookRequest' - responses: - default: - content: - application/json: {} - description: default response - tags: - - HTTP Provisioner Webhook -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DeprovisionedResource: - type: object - example: null - properties: - error: - type: boolean - example: null - errorMessage: - type: string - example: null - inProcess: - type: boolean - example: null - provisionedResourceId: - type: string - example: null - ProvisionerWebhookRequest: - type: object - example: null - properties: - apiKeyJwt: - type: string - example: null - assetId: - type: string - example: null - contentDataAddress: - $ref: '#/components/schemas/DataAddress' - hasToken: - type: boolean - example: null - resourceDefinitionId: - type: string - example: null - resourceName: - type: string - example: null diff --git a/resources/openapi/yaml/management-api/transfer-process-api.yaml b/resources/openapi/yaml/management-api/transfer-process-api.yaml deleted file mode 100644 index 0e2709c1289..00000000000 --- a/resources/openapi/yaml/management-api/transfer-process-api.yaml +++ /dev/null @@ -1,580 +0,0 @@ -openapi: 3.0.1 -paths: - /v2/transferprocesses: - post: - description: "Initiates a data transfer with the given parameters. Please note\ - \ that successfully invoking this endpoint only means that the transfer was\ - \ initiated. Clients must poll the /{id}/state endpoint to track the state" - operationId: initiateTransferProcess - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TransferRequest' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponse' - description: The transfer was successfully initiated. Returns the transfer - process ID and created timestamp - links: - poll-state: - operationId: getTransferProcessState - parameters: - id: $response.body#/id - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Transfer Process - /v2/transferprocesses/request: - post: - description: Returns all transfer process according to a query - operationId: queryTransferProcesses - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpec' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/TransferProcess' - description: The transfer processes matching the query - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Transfer Process - /v2/transferprocesses/{id}: - get: - description: Gets an transfer process with the given ID - operationId: getTransferProcess - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TransferProcess' - description: The transfer process - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A transfer process with the given ID does not exist - tags: - - Transfer Process - /v2/transferprocesses/{id}/deprovision: - post: - description: "Requests the deprovisioning of resources associated with a transfer\ - \ process. Due to the asynchronous nature of transfers, a successful response\ - \ only indicates that the request was successfully received. This may take\ - \ a long time, so clients must poll the /{id}/state endpoint to track the\ - \ state." - operationId: deprovisionTransferProcess - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Request to deprovision the transfer process was successfully - received - links: - poll-state: - operationId: getTransferProcessState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - tags: - - Transfer Process - /v2/transferprocesses/{id}/state: - get: - description: Gets the state of a transfer process with the given ID - operationId: getTransferProcessState - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TransferState' - description: The transfer process's state - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An transfer process with the given ID does not exist - tags: - - Transfer Process - /v2/transferprocesses/{id}/terminate: - post: - description: "Requests the termination of a transfer process. Due to the asynchronous\ - \ nature of transfers, a successful response only indicates that the request\ - \ was successfully received. Clients must poll the /{id}/state endpoint to\ - \ track the state." - operationId: terminateTransferProcess - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TerminateTransfer' - responses: - "200": - description: Request to cancel the transfer process was successfully received - links: - poll-state: - operationId: getTransferProcessState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not terminate transfer process, because it is already\ - \ completed or terminated." - tags: - - Transfer Process -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: object - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - CallbackAddress: - type: object - example: null - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/CallbackAddress - authCodeId: - type: string - example: null - authKey: - type: string - example: null - events: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - transactional: - type: boolean - example: null - uri: - type: string - example: null - Criterion: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': Criterion - operandLeft: fieldName - operator: = - operandRight: some value - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/Criterion - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - DataAddress: - type: object - example: null - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/DataAddress - type: - type: string - example: null - IdResponse: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@id': id-value - createdAt: 1688465655 - properties: - '@id': - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - JsonArray: - type: array - example: null - items: - $ref: '#/components/schemas/JsonValue' - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - QuerySpec: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': QuerySpec - offset: 5 - limit: 10 - sortOrder: DESC - sortField: fieldName - filterExpression: [] - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/QuerySpec - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/Criterion' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null - TerminateTransfer: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/TerminateTransfer - reason: a reason to terminate - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/TransferState - state: - type: string - example: null - TransferProcess: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/TransferProcess - '@id': process-id - correlationId: correlation-id - type: PROVIDER - state: STARTED - stateTimestamp: 1688465655 - assetId: asset-id - connectorId: connectorId - contractId: contractId - dataDestination: - type: data-destination-type - properties: - key: value - privateProperties: - private-key: private-value - errorDetail: eventual-error-detail - createdAt: 1688465655 - callbackAddresses: - - transactional: false - uri: http://callback/url - events: - - contract.negotiation - - transfer.process - authKey: auth-key - authCodeId: auth-code-id - properties: - '@id': - type: string - example: null - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/TransferProcess - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddress' - contractAgreementId: - type: string - example: null - counterPartyAddress: - type: string - example: null - counterPartyId: - type: string - example: null - errorDetail: - type: string - example: null - protocol: - type: string - example: null - state: - type: string - example: null - type: - type: string - enum: - - CONSUMER - - PROVIDER - example: null - TransferRequest: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/TransferRequest - protocol: dataspace-protocol-http - connectorAddress: http://provider-address - connectorId: provider-id - contractId: contract-id - assetId: asset-id - dataDestination: - type: data-destination-type - properties: - key: value - privateProperties: - private-key: private-value - callbackAddresses: - - transactional: false - uri: http://callback/url - events: - - contract.negotiation - - transfer.process - authKey: auth-key - authCodeId: auth-code-id - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/TransferRequest - assetId: - type: string - example: null - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddress' - connectorAddress: - type: string - example: null - connectorId: - type: string - example: null - contractId: - type: string - example: null - dataDestination: - $ref: '#/components/schemas/DataAddress' - privateProperties: - type: object - additionalProperties: - type: string - example: null - example: null - properties: - type: object - additionalProperties: - type: string - example: null - example: null - protocol: - type: string - example: null - TransferState: - type: object - example: - '@context': - edc: https://w3id.org/edc/v0.0.1/ns/ - '@type': https://w3id.org/edc/v0.0.1/ns/TransferState - state: STARTED - properties: - '@type': - type: string - example: https://w3id.org/edc/v0.0.1/ns/TransferState - state: - type: string - example: null