From 6386ec39fbdb959a5b50c3654530280da517be76 Mon Sep 17 00:00:00 2001 From: Kris West Date: Fri, 6 May 2022 16:09:57 +0100 Subject: [PATCH 1/2] removing appD create application endpoint --- CHANGELOG.md | 3 +- docs/app-directory/spec.md | 1 - src/app-directory/specification/appd.yaml | 43 ------------------- .../static/schemas/next/app-directory.yaml | 43 ------------------- 4 files changed, 2 insertions(+), 88 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 889ad023f..76cfdd2e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,7 +38,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). * Moved the Icon type definition into the Types documentation page for consistency with other types. ([#493](https://github.com/finos/FDC3/pull/493) * The `fdc3.joinChannel()`, `fdc3.getCurrentChannel()` and `fdc3.leaveCurrentChannel()` functions have been made optional for FDC3 API compliance, but are recommended through the application of the SHOULD keyword. ([#512](https://github.com/finos/FDC3/pull/512)) * All DesktopAgent and Channel API functions are now async for consistency, changing the return type of the `broadcast`, `addIntentListener`, `addContextListener` and `getInfo` functions ([#516](https://github.com/finos/FDC3/pull/516)) -* AppD `images` field was replaced with `screenshots` to better align the applicaiton record with web application manifest and match its format to that used by `icons` ([#675](https://github.com/finos/FDC3/pull/675)) +* App Directory `images` field was replaced with `screenshots` to better align the application record with web application manifest and match its format to that used by `icons` ([#675](https://github.com/finos/FDC3/pull/675)) +* App Directory endpoint for creating applications was removed as these will often be implementation dependent and should not be required for compliance ([#](https://github.com/finos/FDC3/pull/)) ### Deprecated * Removed details of the 'global' channel that was deprecated in FDC3 1.2. ([#496](https://github.com/finos/FDC3/pull/496)) diff --git a/docs/app-directory/spec.md b/docs/app-directory/spec.md index 492b32869..6ba765788 100644 --- a/docs/app-directory/spec.md +++ b/docs/app-directory/spec.md @@ -12,7 +12,6 @@ View the [full specification](/schemas/next/app-directory) in [OpenAPI v3.0](htt Endpoint | Method | Description ------------------ | ------ | ----------- `/v2/apps` | GET | Retrieve all application definitions - `/v2/apps` | POST | Create a new application definition `/v2/apps/{appId}` | GET | Retrieve an application defintion `/v2/apps/search` | GET | Retrieve a list of applications `/v1/apps` | POST | (deprecated v1 API version) Create a new application definition diff --git a/src/app-directory/specification/appd.yaml b/src/app-directory/specification/appd.yaml index 74edb2c82..ede6fbd0d 100644 --- a/src/app-directory/specification/appd.yaml +++ b/src/app-directory/specification/appd.yaml @@ -88,49 +88,6 @@ paths: $ref: '#/components/schemas/ErrorDTO' tags: - Application - post: - summary: Create a new application definition - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Application' - examples: - FDC3WorkbenchAppDefinition: - $ref: '#/components/examples/FDC3WorkbenchAppDefinition' - '400': - description: Bad request. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorDTO' - '403': - description: >- - Forbidden: Certificate authentication is not allowed for the - requested user. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorDTO' - '500': - description: 'Server error, see response body for further details.' - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorDTO' - tags: - - Application - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Application' - examples: - FDC3WorkbenchAppDefinition: - $ref: '#/components/examples/FDC3WorkbenchAppDefinition' - required: true /v2/apps/search: get: summary: Retrieve a list of applications based on parameters provided. Depending on implementation, parameter diff --git a/website/static/schemas/next/app-directory.yaml b/website/static/schemas/next/app-directory.yaml index 74edb2c82..ede6fbd0d 100644 --- a/website/static/schemas/next/app-directory.yaml +++ b/website/static/schemas/next/app-directory.yaml @@ -88,49 +88,6 @@ paths: $ref: '#/components/schemas/ErrorDTO' tags: - Application - post: - summary: Create a new application definition - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Application' - examples: - FDC3WorkbenchAppDefinition: - $ref: '#/components/examples/FDC3WorkbenchAppDefinition' - '400': - description: Bad request. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorDTO' - '403': - description: >- - Forbidden: Certificate authentication is not allowed for the - requested user. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorDTO' - '500': - description: 'Server error, see response body for further details.' - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorDTO' - tags: - - Application - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Application' - examples: - FDC3WorkbenchAppDefinition: - $ref: '#/components/examples/FDC3WorkbenchAppDefinition' - required: true /v2/apps/search: get: summary: Retrieve a list of applications based on parameters provided. Depending on implementation, parameter From ef3f6ead79ce4af5f3ea6844e764ea5a196b6073 Mon Sep 17 00:00:00 2001 From: Kris West Date: Fri, 6 May 2022 16:15:22 +0100 Subject: [PATCH 2/2] changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 76cfdd2e7..02ed30242 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -39,7 +39,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). * The `fdc3.joinChannel()`, `fdc3.getCurrentChannel()` and `fdc3.leaveCurrentChannel()` functions have been made optional for FDC3 API compliance, but are recommended through the application of the SHOULD keyword. ([#512](https://github.com/finos/FDC3/pull/512)) * All DesktopAgent and Channel API functions are now async for consistency, changing the return type of the `broadcast`, `addIntentListener`, `addContextListener` and `getInfo` functions ([#516](https://github.com/finos/FDC3/pull/516)) * App Directory `images` field was replaced with `screenshots` to better align the application record with web application manifest and match its format to that used by `icons` ([#675](https://github.com/finos/FDC3/pull/675)) -* App Directory endpoint for creating applications was removed as these will often be implementation dependent and should not be required for compliance ([#](https://github.com/finos/FDC3/pull/)) +* App Directory endpoint for creating applications was removed as these will often be implementation dependent and should not be required for compliance ([#695](https://github.com/finos/FDC3/pull/695)) ### Deprecated * Removed details of the 'global' channel that was deprecated in FDC3 1.2. ([#496](https://github.com/finos/FDC3/pull/496))