rest_api: Suggest renaming resolve to reference in dependent resources

[burnash]

Background

In the current rest_api source configuration, the "resolve" keyword is used to link resources and fields across endpoints:

{
    "client": {
        # ...
    },
    "resources": [
        {
            "name": "issues",
            "endpoint": {
                "path": "issues",
                "params": {
                    "since": {
                        "type": "incremental",
                        "cursor_path": "updated_at",
                        "initial_value": "2024-01-25T11:21:28Z",
                    },
                },
            },
        },
        {
            "name": "issue_comments",
            "endpoint": {
                "path": "issues/{issue_number}/comments",
                "params": {
                    "issue_number": {
                        "type": "resolve",                               # <-- This
                        "resource": "issues",
                        "field": "number",
                    }
                },
            },
        },
    ],
}

Proposal

I suggest renaming "resolve" to "reference" for improved clarity and better alignment with its function:

{
    "client": {
        # ...
    },
    "resources": [
        {
            "name": "issues",
            "endpoint": {
                "path": "issues",
                "params": {
                    "since": {
                        "type": "incremental",
                        "cursor_path": "updated_at",
                        "initial_value": "2024-01-25T11:21:28Z",
                    },
                },
            },
        },
        {
            "name": "issue_comments",
            "endpoint": {
                "path": "issues/{issue_number}/comments",
                "params": {
                    "issue_number": {
                        "type": "reference",                               # <-- To this
                        "resource": "issues",
                        "field": "number",
                    }
                },
            },
        },
    ],
}

[burnash]

This is no longer relevant as we're planning to migrate to a different syntax: #2190