Create guide to list and update identifiers

[sebastiendeschambault-flare]

Guide:

Here's the copy pasted python example, I tested the script to update the name of some identifiers:

import time

from flareio import FlareApiClient

api_client = FlareApiClient.from_env()

last_from: str | None = None

# 1. List all identifiers
for resp in api_client.scroll(
    method="GET",
    url="/firework/v3/identifiers/",
    params={
        "from": last_from,
        "size": 20,
    },
):
    # Rate limiting (default).
    time.sleep(0.25)

    data = resp.json()
    items = data.get("items", [])
    last_from = data.get("next") or last_from

    for item in items:
        # Rate limiting (default).
        time.sleep(0.25)

        identifier_id = item.get("id")

        # 2. Get the full identifier by ID
        identifier_resp = api_client.get(f"/firework/v3/identifiers/{identifier_id}")
        identifier = identifier_resp.json().get("identifier")

        # Rate limiting (default).
        time.sleep(0.25)

        # 3. Do the necessary updates to the identifier
        api_client.put(
            f"/firework/v2/assets/{identifier_id}",
            json={
                "name": identifier.get("name", "")
                + " (updated)",  # Example: update name or other fields
                "type": identifier.get("type"),  # Required
                "data": identifier.get("data"),  # Required
                # Include other fields from the Identifier schema as needed
            },
        )
        print(f"Updated identifier {identifier_id}")

[aviau]

remove this?

[aviau]

remove this?

[aviau]

set to

        "from": None,

[sebastiendeschambault-flare]

updated script:

import time

from flareio import FlareApiClient

api_client = FlareApiClient.from_env()

# 1. List all identifiers
for resp in api_client.scroll(
    method="GET",
    url="/firework/v3/identifiers/",
):
    # Rate limiting (default).
    time.sleep(0.25)

    data = resp.json()
    items = data.get("items", [])

    for item in items:
        # Rate limiting (default).
        time.sleep(0.25)

        identifier_id = item.get("id")

        # 2. Get the full identifier by ID
        identifier_resp = api_client.get(f"/firework/v3/identifiers/{identifier_id}")
        identifier = identifier_resp.json().get("identifier")

        # Rate limiting (default).
        time.sleep(0.25)

        # 3. Do the necessary updates to the identifier
        api_client.put(
            f"/firework/v2/assets/{identifier_id}",
            json={
                "name": identifier.get("name", "")
                + " (updated)",  # Example: update name or other fields
                "type": identifier.get("type"),  # Required
                "data": identifier.get("data"),  # Required
                # Include other fields from the Identifier schema as needed
            },
        )
        print(f"Updated identifier {identifier_id}")