Commit dcbef481 authored by Dimitrios Gogos's avatar Dimitrios Gogos
Browse files

feat: update oeg docs from 'vwip' to 'v0.1alpha1'

parent c89c2e37

external-specs/camara-edge-application-management/VERSION.md

+15 −24
Changes for external-specs/camara-edge-application-management/VERSION.md: 15 added lines, 24 removed lines.
Original line number Diff line number Diff line
@@ -5,8 +5,8 @@ description: "Pinned OpenAPI snapshot from camaraproject/EdgeApplicationManageme 
tags: [external-spec, camara, oeg]

timestamp: 2026-07-07T00:00:00Z

component: external

version: "1.1"

status: "wip — API info.version is wip; pinned at upstream commit 7924d48 (see Provenance)"

version: "1.2"

status: "API info.version 0.1.0-alpha.1; pinned at upstream release r1.1, commit 8798eac (see Provenance)"

---



# CAMARA Edge Application Management — Vendored Spec Snapshot
@@ -14,35 +14,27 @@ status: "wip — API info.version is wip; pinned at upstream commit 7924d48 (see 
**Companion documents:** [external-specs/index.md](/external-specs/index.md) (vendoring convention, ADR-0026)



Source repo: https://github.com/camaraproject/EdgeApplicationManagement

Branch fetched: `main`

Fetched: 2026-07-04

Fetched from: release tag `r1.1` (main spec); `main` (common files)

Fetched: 2026-09-30 (main spec); 2026-07-04 (common files)

License: Apache-2.0 (upstream repository)



## Why a commit is recorded here



The API `info.version` field in this spec is `wip` (work-in-progress, no

release tag yet). A `wip` version string is not itself reproducible — the

same version string can point to different content over time as `main`

moves. The commit SHA below is the only reliable way to know exactly which

revision of the spec these files represent.



## Provenance



| File | API `version` | `x-camara-commonalities` | Last commit touching file | Commit date |

|---|---|---|---|---|

| `code/API_definitions/edge-application-management.yaml` | `wip` | `0.8.0` | [`0a64e15`](https://github.com/camaraproject/EdgeApplicationManagement/commit/0a64e153e8b860f9a8b7c045fe2e840e7278dada) | 2026-06-26 |

| `code/API_definitions/edge-application-management.yaml` | `0.1.0-alpha.1` | `0.8.0` | [`8798eac`](https://github.com/camaraproject/EdgeApplicationManagement/commit/8798eacc09c9017af2998b41ae864555c0593d9b) (release tag [`r1.1`](https://github.com/camaraproject/EdgeApplicationManagement/releases/tag/r1.1)) | 2026-06-02 |

| `code/common/CAMARA_common.yaml` | `wip` | `0.8.0` | [`ab99e32`](https://github.com/camaraproject/EdgeApplicationManagement/commit/ab99e328536808e2ed27d964ca1fbb8edcfca75b) | 2026-05-28 (synced from Commonalities r4.3) |

| `code/common/CAMARA_event_common.yaml` | `wip` | `0.8.0` | [`ab99e32`](https://github.com/camaraproject/EdgeApplicationManagement/commit/ab99e328536808e2ed27d964ca1fbb8edcfca75b) | 2026-05-28 (synced from Commonalities r4.3) |



**Repo HEAD at fetch time (`main`):** [`7924d48`](https://github.com/camaraproject/EdgeApplicationManagement/commit/7924d48765d026baed1114ebb6d8fd1116ccc419) — "Merge pull request #44 from DLondonoD/dev-hints01: Improve API definitions with common response components and validation patterns" (2026-06-30T15:23:31Z)



To pin an exact reproducible copy later, fetch via the commit SHA instead of

`main`, e.g.:

The main spec is the same file OEG vendors. To fetch it:



```

https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/0a64e153e8b860f9a8b7c045fe2e840e7278dada/code/API_definitions/edge-application-management.yaml

https://raw.githubusercontent.com/camaraproject/EdgeApplicationManagement/8798eacc09c9017af2998b41ae864555c0593d9b/code/API_definitions/edge-application-management.yaml

```



The two `code/common/` files are from the earlier `wip` snapshot (fetched 2026-07-04). The

`r1.1` main spec is self-contained and does not `$ref` them.



## Contents



```
@@ -50,8 +42,8 @@ code/ 
├── API_definitions/

│   └── edge-application-management.yaml   # main OpenAPI spec (paths: /apps, /appinstances, /deployments, /clusters, /edge-cloud-zones)

└── common/

    ├── CAMARA_common.yaml                  # shared CAMARA error responses/schemas ($ref'd by the main spec)

    └── CAMARA_event_common.yaml            # shared CloudEvent schema ($ref'd by the main spec)

    ├── CAMARA_common.yaml                  # shared CAMARA error responses/schemas (not referenced by the r1.1 main spec)

    └── CAMARA_event_common.yaml            # shared CloudEvent schema (not referenced by the r1.1 main spec)

```



`Test_definitions/` and `code/common/.sync-manifest.yaml` /
@@ -73,10 +65,8 @@ flows: [oeg/app-instance-flow.md](/oeg/app-instance-flow.md) (single zone) 
and [oeg/app-deployment-flow.md](/oeg/app-deployment-flow.md) (multi-zone);

see also ADR-0005 and ADR-0007.



**OOP Release 2 URL pin.** The vendored OpenAPI `servers` entry uses path segment `vwip` while

`info.version` is `wip`. OOP exposes `/edge-application-management/v1/...` on the wire; the

vendored snapshot remains the normative schema source

([oeg/architecture.md](/oeg/architecture.md) §H.1).

**URL pin.** The vendored OpenAPI `servers` entry uses path segment `v0.1alpha1`; OEG serves

`/edge-application-management/v0.1alpha1/...` ([oeg/architecture.md](/oeg/architecture.md) §H.1).



## Revision History
@@ -84,3 +74,4 @@ vendored snapshot remains the normative schema source 
|---------|------|---------|

| 1.0 | 2026-07-04 | Initial vendored CAMARA EAM snapshot (fetched 2026-07-04, repo HEAD 7924d48). |

| 1.1 | 2026-07-07 | OKF frontmatter, license note, link to external-specs index and ADR-0026. OOP Release 2 URL pin: exposed segment `v1` vs vendored `vwip`/`wip` documented. |

| 1.2 | 2026-09-30 | Main spec re-vendored at upstream release `r1.1` (`0.1.0-alpha.1`, commit 8798eac), matching OEG; path segment `vwip` → `v0.1alpha1`. |

external-specs/camara-edge-application-management/code/API_definitions/edge-application-management.yaml

+738 −479

File changed.

Preview size limit exceeded, changes collapsed.

oeg/app-deployment-flow.md

+2 −2
Changes for oeg/app-deployment-flow.md: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -50,7 +50,7 @@ resource with its own id) and the number of `targets[]` in the command. 
## 1. NBI (Northbound Interface) Endpoint



```

POST /edge-application-management/vwip/deployments

POST /edge-application-management/v0.1alpha1/deployments

Authorization: Bearer <JWT>

Idempotency-Key: <client-generated-key>  (optional)

X-Correlator: <uuid>                      (optional)
@@ -174,7 +174,7 @@ Per the CAMARA spec the 202 body carries **only `appDeploymentId`**. 
```

HTTP 202 Accepted

X-Correlator: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Location: https://api.example.com/edge-application-management/vwip/deployments/5e2f0b7c-0000-4000-8000-000000000010

Location: https://api.example.com/edge-application-management/v0.1alpha1/deployments/5e2f0b7c-0000-4000-8000-000000000010

```



```json

oeg/app-instance-flow.md

+5 −5
Changes for oeg/app-instance-flow.md: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -61,7 +61,7 @@ to the DataBus and returns without waiting for SRM to fulfill the request. 
## 1. NBI Endpoint



```

POST /edge-application-management/vwip/appinstances

POST /edge-application-management/v0.1alpha1/appinstances

Authorization: Bearer <JWT>

Idempotency-Key: <client-generated-key>  (optional)

X-Correlator: <uuid>                      (optional)
@@ -69,11 +69,11 @@ Content-Type: application/json 
```



> **Phase 1:** client-facing URL equals OEG mount (no Nginx). **Phase 2+:** Nginx adds `/api`

> ingress prefix — `POST /api/edge-application-management/vwip/appinstances` (ADR-0020;

> ingress prefix — `POST /api/edge-application-management/v0.1alpha1/appinstances` (ADR-0020;

> [oeg/interface-contract.md](/oeg/interface-contract.md) §K.0).



> **Path casing / version.** The CAMARA spec uses the lowercase collection `appinstances` and an

> `info.version` of `wip`; OEG mounts the family at that vendored `vwip` segment exactly, with no

> `info.version` of `0.1.0-alpha.1`; OEG mounts the family at that vendored `v0.1alpha1` segment exactly, with no

> OOP version substitution (ADR-0020). The multi-zone

> `deployments` collection is documented in [oeg/app-deployment-flow.md](/oeg/app-deployment-flow.md).

>
@@ -524,7 +524,7 @@ Returned immediately after OEG writes the `operations` + `app_instances` rows an 
```

HTTP 202 Accepted

X-Correlator: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Location: https://api.example.com/edge-application-management/vwip/appinstances/9a3f1c22-0000-4000-8000-000000000002

Location: https://api.example.com/edge-application-management/v0.1alpha1/appinstances/9a3f1c22-0000-4000-8000-000000000002

```



```json
@@ -638,7 +638,7 @@ Authorization: Bearer <sinkCredential access token> 
```json

{

  "id": "8f7f4b1e-0000-4000-8000-000000000042",

  "source": "https://api.example.com/edge-application-management/vwip",

  "source": "https://api.example.com/edge-application-management/v0.1alpha1",

  "specversion": "1.0",

  "type": "org.camaraproject.edge-application-management.v0.app-instance-status-change",

  "time": "2026-07-04T10:02:35Z",

oeg/app-registration-flow.md

+1 −1
Changes for oeg/app-registration-flow.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ specification id and SRM adopts it (ADR-0011; `appId` is sent only as 
## 2. NBI Endpoint



```

POST /edge-application-management/vwip/apps

POST /edge-application-management/v0.1alpha1/apps

Authorization: Bearer <JWT>

Content-Type: application/json

```