Commit f29608d9 authored by Sergio Gimenez's avatar Sergio Gimenez
Browse files

update docs

parent 078d6d60

docs/manual-api-e2e-testing.md

+108 −0
Original line number Diff line number Diff line
@@ -164,6 +164,40 @@ curl -sS -X POST "$OEG_BASE_URL/apps" \ 
EOF

```



Swagger copy-paste form (`POST /apps`):



```json

{

  "appId": "18909090-9090-4909-8909-189090909090",

  "name": "federatednginxoci",

  "appProvider": "Local_Oper",

  "version": "1",

  "packageType": "CONTAINER",

  "appRepo": {

    "type": "PUBLICREPO",

    "imagePath": "nginx:latest"

  },

  "requiredResources": {

    "infraKind": "container",

    "numCPU": "100m",

    "memory": 512

  },

  "componentSpec": [

    {

      "componentName": "frontend",

      "networkInterfaces": [

        {

          "interfaceId": "eth0",

          "protocol": "TCP",

          "port": 80,

          "visibilityType": "VISIBILITY_EXTERNAL"

        }

      ]

    }

  ]

}

```



Inspect app:



```bash
@@ -195,6 +229,25 @@ EOF 
printf '%s\n' "$LOCAL_DEPLOY_RESPONSE"

```



Swagger copy-paste form (`POST /appinstances` for local deploy):



```json

{

  "appId": "18909090-9090-4909-8909-189090909090",

  "appZones": [

    {

      "EdgeCloudZone": {

        "edgeCloudZoneId": "47056b13-494d-4e68-a7e7-88a783d69b1d",

        "edgeCloudZoneName": "op1-control-plane",

        "edgeCloudProvider": "Local Operator",

        "edgeCloudZoneStatus": "active",

        "edgeCloudRegion": "unknown"

      }

    }

  ]

}

```



Extract local instance id:



```bash
@@ -250,6 +303,16 @@ EOF 
printf '%s\n' "$FED_CREATE_RESPONSE"

```



Swagger copy-paste form (`POST /partner`):



```json

{

  "origOPFederationId": "oop-local",

  "initialDate": "2026-05-04T12:00:00Z",

  "partnerStatusLink": "http://oeg.oop.svc.cluster.local/oeg/1.0.0/partner/notifications"

}

```



Extract federation id:



```bash
@@ -276,6 +339,17 @@ curl -sS -X POST "$OEG_BASE_URL/$FEDERATION_CONTEXT_ID/zones" \ 
EOF

```



Swagger copy-paste form (`POST /{federationContextId}/zones`):



```json

{

  "acceptedAvailabilityZones": [

    "5460f101-e44c-4dae-b41b-cb7752aafced"

  ],

  "availZoneNotifLink": "http://oeg.oop.svc.cluster.local/oeg/1.0.0/edge-cloud-zones/notifications"

}

```



Notes:



- `409` acceptable if zone already subscribed
@@ -325,6 +399,25 @@ EOF 
printf '%s\n' "$REMOTE_DEPLOY_RESPONSE"

```



Swagger copy-paste form (`POST /appinstances` for federated deploy):



```json

{

  "appId": "18909090-9090-4909-8909-189090909090",

  "appZones": [

    {

      "EdgeCloudZone": {

        "edgeCloudZoneId": "5460f101-e44c-4dae-b41b-cb7752aafced",

        "edgeCloudZoneName": "unknown",

        "edgeCloudProvider": "Remote Operator",

        "edgeCloudZoneStatus": "unknown",

        "edgeCloudRegion": "unknown"

      }

    }

  ]

}

```



Extract remote instance id:



```bash
@@ -417,18 +510,33 @@ curl -sS "$OEG_BASE_URL/appinstances?appId=$APP_ID" 
curl -sS -X DELETE "$OEG_BASE_URL/apps/$APP_ID"

```



Swagger execution:



- `DELETE /apps/{appId}` with `appId=18909090-9090-4909-8909-189090909090`



### 9.3 Unsubscribe remote zone



```bash

curl -sS -X DELETE "$OEG_BASE_URL/$FEDERATION_CONTEXT_ID/zones/$FEDERATED_ZONE_ID"

```



Swagger execution:



- `DELETE /{federationContextId}/zones/{zoneId}`

- `federationContextId=<current FEDERATION_CONTEXT_ID>`

- `zoneId=5460f101-e44c-4dae-b41b-cb7752aafced`



### 9.4 Delete federation context



```bash

curl -sS -X DELETE "$OEG_BASE_URL/$FEDERATION_CONTEXT_ID/partner"

```



Swagger execution:



- `DELETE /{federationContextId}/partner`

- `federationContextId=<current FEDERATION_CONTEXT_ID>`



Verify cleanup:



```bash