Vai al contenuto
AdiosDocumentazione
Esplora la documentazione

API delle sorgenti degli spazi di lavoro

Gestisci i repository montati in uno spazio di lavoro. Per i riferimenti ai repository, usa gli identificativi restituiti dall’API.

Usa Autenticazione API per le richieste protette. Gli esempi usano i tuoi ID di risorse e un token temporaneo; gli esempi di risposte salvate sono sintetici.

MetodoPercorsoOperazione
GET/v1/workspace_sourceElenca le sorgenti dello spazio di lavoro
POST/v1/workspace_sourceCrea una sorgente dello spazio di lavoro
GET/v1/workspace_source/{id}Ottieni una sorgente dello spazio di lavoro
PUT/v1/workspace_source/{id}Aggiorna una sorgente dello spazio di lavoro
DELETE/v1/workspace_source/{id}Elimina una sorgente dello spazio di lavoro

Elenca le sorgenti dello spazio di lavoro

GET /v1/workspace_source

Restituisce un elenco paginato di WorkspaceSource

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.
pagequeryNoNumero di pagina
per_pagequeryNoElementi per pagina

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace_source" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Elenco di WorkspaceSource

Campi di risposta

CampoTipoDescrizione
dataarray
data[].aliasstring
data[].branchstring
data[].commitstring
data[].created_atinteger(timestamp Unix)
data[].deleted_atinteger(timestamp Unix)
data[].external_auth_refstringSolo un riferimento alle credenziali; i valori segreti non vengono mai conservati qui
data[].external_connection_idstring
data[].external_providerstringValori consentiti: none, github, gitlab, bitbucket, ssh, git.
data[].external_repository_urlstring
data[].internal_repository_idstringRepository autorevole in Adios Git
data[].internal_repository_urlstringURL di clonazione privo di credenziali per il repository Adios Git autorevole
data[].last_synced_atinteger(timestamp Unix)
data[].metadataobject
data[].mountstring
data[].repository_pathstring
data[].rolestringValori consentiti: primary, include.
data[].source_keystringIdentità logica priva di credenziali usata per riutilizzare un repository interno in più spazi di lavoro
data[].statusstringValori consentiti: active, archived.
data[].sync_directionstringValori consentiti: none, pull, push, bidirectional.
data[].sync_errorobject
data[].sync_statusstringValori consentiti: internal_only, pending, synced, ahead, behind, diverged, error.
data[].team_idstring
data[].updated_atinteger(timestamp Unix)
data[].workspace_idstring
data[].workspace_source_idstring
paginationobject
pagination.pageintegerNumero di pagina attuale
pagination.per_pageintegerNumero di elementi per pagina
pagination.totalintegerNumero totale di elementi

Esempio illustrativo; non è una risposta dal vivo:

{
  "data": [
    {
      "alias": "example",
      "branch": "main",
      "commit": "",
      "created_at": 1791072000,
      "deleted_at": 0,
      "external_auth_ref": "",
      "external_connection_id": "",
      "external_provider": "none",
      "external_repository_url": "",
      "internal_repository_id": "000000000000000000000000001",
      "internal_repository_url": "example",
      "last_synced_at": 0,
      "metadata": {},
      "mount": ".",
      "repository_path": ".",
      "role": "include",
      "source_key": "",
      "status": "active",
      "sync_direction": "none",
      "sync_error": "",
      "sync_status": "internal_only",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "workspace_id": "000000000000000000000000001",
      "workspace_source_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Crea una sorgente dello spazio di lavoro

POST /v1/workspace_source

Crea un nuovo oggetto WorkspaceSource

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

CampoTipoObbligatorioDescrizione
aliasstringSì
branchstringSìValore predefinito: "main".
commitstringNoValore predefinito: "".
external_auth_refstringNoSolo un riferimento alle credenziali; i valori segreti non vengono mai conservati qui. Valore predefinito: "".
external_connection_idstringNoValore predefinito: "".
external_providerstringSìValori consentiti: none, github, gitlab, bitbucket, ssh, git. Valore predefinito: "none".
external_repository_urlstringNoValore predefinito: "".
internal_repository_idstringSìRepository autorevole in Adios Git
internal_repository_urlstringSìURL di clonazione privo di credenziali per il repository Adios Git autorevole
last_synced_atintegerNo(timestamp Unix) Valore predefinito: 0.
metadataobjectNo
mountstringSìValore predefinito: ".".
repository_pathstringSìValore predefinito: ".".
rolestringSìValori consentiti: primary, include. Valore predefinito: "include".
source_keystringSìIdentità logica priva di credenziali usata per riutilizzare un repository interno in più spazi di lavoro. Valore predefinito: "".
statusstringSìValori consentiti: active, archived. Valore predefinito: "active".
sync_directionstringSìValori consentiti: none, pull, push, bidirectional. Valore predefinito: "none".
sync_errorobjectNoValore predefinito: "".
sync_statusstringSìValori consentiti: internal_only, pending, synced, ahead, behind, diverged, error. Valore predefinito: "internal_only".
team_idstringSì
workspace_idstringSì

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workspace_source" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "alias": "example",
  "branch": "main",
  "commit": "",
  "external_auth_ref": "",
  "external_connection_id": "",
  "external_provider": "none",
  "external_repository_url": "",
  "internal_repository_id": "YOUR_INTERNAL_REPOSITORY_ID",
  "internal_repository_url": "YOUR_INTERNAL_REPOSITORY_URL",
  "last_synced_at": 0,
  "mount": ".",
  "repository_path": ".",
  "role": "include",
  "source_key": "",
  "status": "active",
  "sync_direction": "none",
  "sync_error": "",
  "sync_status": "internal_only",
  "team_id": "YOUR_TEAM_ID",
  "workspace_id": "YOUR_WORKSPACE_ID"
}
JSON

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 201

WorkspaceSource creato

Campi di risposta

CampoTipoDescrizione
aliasstring
branchstring
commitstring
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
external_auth_refstringSolo un riferimento alle credenziali; i valori segreti non vengono mai conservati qui
external_connection_idstring
external_providerstringValori consentiti: none, github, gitlab, bitbucket, ssh, git.
external_repository_urlstring
internal_repository_idstringRepository autorevole in Adios Git
internal_repository_urlstringURL di clonazione privo di credenziali per il repository Adios Git autorevole
last_synced_atinteger(timestamp Unix)
metadataobject
mountstring
repository_pathstring
rolestringValori consentiti: primary, include.
source_keystringIdentità logica priva di credenziali usata per riutilizzare un repository interno in più spazi di lavoro
statusstringValori consentiti: active, archived.
sync_directionstringValori consentiti: none, pull, push, bidirectional.
sync_errorobject
sync_statusstringValori consentiti: internal_only, pending, synced, ahead, behind, diverged, error.
team_idstring
updated_atinteger(timestamp Unix)
workspace_idstring
workspace_source_idstring

Esempio illustrativo; non è una risposta dal vivo:

{
  "alias": "example",
  "branch": "main",
  "commit": "",
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_auth_ref": "",
  "external_connection_id": "",
  "external_provider": "none",
  "external_repository_url": "",
  "internal_repository_id": "000000000000000000000000001",
  "internal_repository_url": "example",
  "last_synced_at": 0,
  "metadata": {},
  "mount": ".",
  "repository_path": ".",
  "role": "include",
  "source_key": "",
  "status": "active",
  "sync_direction": "none",
  "sync_error": "",
  "sync_status": "internal_only",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "workspace_id": "000000000000000000000000001",
  "workspace_source_id": "000000000000000000000000001"
}

Ottieni una sorgente dello spazio di lavoro

GET /v1/workspace_source/{id}

Restituisce un oggetto WorkspaceSource

Imposta workspace_source_id usando gli ID restituiti dalle tue risposte API.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
idpathSìIdentificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace_source/${ADIOS_WORKSPACE_SOURCE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

WorkspaceSource

Campi di risposta

CampoTipoDescrizione
aliasstring
branchstring
commitstring
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
external_auth_refstringSolo un riferimento alle credenziali; i valori segreti non vengono mai conservati qui
external_connection_idstring
external_providerstringValori consentiti: none, github, gitlab, bitbucket, ssh, git.
external_repository_urlstring
internal_repository_idstringRepository autorevole in Adios Git
internal_repository_urlstringURL di clonazione privo di credenziali per il repository Adios Git autorevole
last_synced_atinteger(timestamp Unix)
metadataobject
mountstring
repository_pathstring
rolestringValori consentiti: primary, include.
source_keystringIdentità logica priva di credenziali usata per riutilizzare un repository interno in più spazi di lavoro
statusstringValori consentiti: active, archived.
sync_directionstringValori consentiti: none, pull, push, bidirectional.
sync_errorobject
sync_statusstringValori consentiti: internal_only, pending, synced, ahead, behind, diverged, error.
team_idstring
updated_atinteger(timestamp Unix)
workspace_idstring
workspace_source_idstring

Esempio illustrativo; non è una risposta dal vivo:

{
  "alias": "example",
  "branch": "main",
  "commit": "",
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_auth_ref": "",
  "external_connection_id": "",
  "external_provider": "none",
  "external_repository_url": "",
  "internal_repository_id": "000000000000000000000000001",
  "internal_repository_url": "example",
  "last_synced_at": 0,
  "metadata": {},
  "mount": ".",
  "repository_path": ".",
  "role": "include",
  "source_key": "",
  "status": "active",
  "sync_direction": "none",
  "sync_error": "",
  "sync_status": "internal_only",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "workspace_id": "000000000000000000000000001",
  "workspace_source_id": "000000000000000000000000001"
}

Aggiorna una sorgente dello spazio di lavoro

PUT /v1/workspace_source/{id}

Aggiorna un oggetto WorkspaceSource esistente

Imposta workspace_source_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

CampoTipoObbligatorioDescrizione
aliasstringSì
branchstringSìValore predefinito: "main".
commitstringNoValore predefinito: "".
external_auth_refstringNoSolo un riferimento alle credenziali; i valori segreti non vengono mai conservati qui. Valore predefinito: "".
external_connection_idstringNoValore predefinito: "".
external_providerstringSìValori consentiti: none, github, gitlab, bitbucket, ssh, git. Valore predefinito: "none".
external_repository_urlstringNoValore predefinito: "".
internal_repository_idstringSìRepository autorevole in Adios Git
internal_repository_urlstringSìURL di clonazione privo di credenziali per il repository Adios Git autorevole
last_synced_atintegerNo(timestamp Unix) Valore predefinito: 0.
metadataobjectNo
mountstringSìValore predefinito: ".".
repository_pathstringSìValore predefinito: ".".
rolestringSìValori consentiti: primary, include. Valore predefinito: "include".
source_keystringSìIdentità logica priva di credenziali usata per riutilizzare un repository interno in più spazi di lavoro. Valore predefinito: "".
statusstringSìValori consentiti: active, archived. Valore predefinito: "active".
sync_directionstringSìValori consentiti: none, pull, push, bidirectional. Valore predefinito: "none".
sync_errorobjectNoValore predefinito: "".
sync_statusstringSìValori consentiti: internal_only, pending, synced, ahead, behind, diverged, error. Valore predefinito: "internal_only".
team_idstringSì
workspace_idstringSì

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
idpathSìIdentificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/workspace_source/${ADIOS_WORKSPACE_SOURCE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "alias": "example",
  "branch": "main",
  "commit": "",
  "external_auth_ref": "",
  "external_connection_id": "",
  "external_provider": "none",
  "external_repository_url": "",
  "internal_repository_id": "YOUR_INTERNAL_REPOSITORY_ID",
  "internal_repository_url": "YOUR_INTERNAL_REPOSITORY_URL",
  "last_synced_at": 0,
  "mount": ".",
  "repository_path": ".",
  "role": "include",
  "source_key": "",
  "status": "active",
  "sync_direction": "none",
  "sync_error": "",
  "sync_status": "internal_only",
  "team_id": "YOUR_TEAM_ID",
  "workspace_id": "YOUR_WORKSPACE_ID"
}
JSON

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 200

WorkspaceSource aggiornato

Campi di risposta

CampoTipoDescrizione
aliasstring
branchstring
commitstring
created_atinteger(timestamp Unix)
deleted_atinteger(timestamp Unix)
external_auth_refstringSolo un riferimento alle credenziali; i valori segreti non vengono mai conservati qui
external_connection_idstring
external_providerstringValori consentiti: none, github, gitlab, bitbucket, ssh, git.
external_repository_urlstring
internal_repository_idstringRepository autorevole in Adios Git
internal_repository_urlstringURL di clonazione privo di credenziali per il repository Adios Git autorevole
last_synced_atinteger(timestamp Unix)
metadataobject
mountstring
repository_pathstring
rolestringValori consentiti: primary, include.
source_keystringIdentità logica priva di credenziali usata per riutilizzare un repository interno in più spazi di lavoro
statusstringValori consentiti: active, archived.
sync_directionstringValori consentiti: none, pull, push, bidirectional.
sync_errorobject
sync_statusstringValori consentiti: internal_only, pending, synced, ahead, behind, diverged, error.
team_idstring
updated_atinteger(timestamp Unix)
workspace_idstring
workspace_source_idstring

Esempio illustrativo; non è una risposta dal vivo:

{
  "alias": "example",
  "branch": "main",
  "commit": "",
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_auth_ref": "",
  "external_connection_id": "",
  "external_provider": "none",
  "external_repository_url": "",
  "internal_repository_id": "000000000000000000000000001",
  "internal_repository_url": "example",
  "last_synced_at": 0,
  "metadata": {},
  "mount": ".",
  "repository_path": ".",
  "role": "include",
  "source_key": "",
  "status": "active",
  "sync_direction": "none",
  "sync_error": "",
  "sync_status": "internal_only",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "workspace_id": "000000000000000000000000001",
  "workspace_source_id": "000000000000000000000000001"
}

Elimina una sorgente dello spazio di lavoro

DELETE /v1/workspace_source/{id}

Elimina un oggetto WorkspaceSource

Imposta workspace_source_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

NomePosizioneObbligatorioDescrizione
idpathSìIdentificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-IDheaderSìID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/workspace_source/${ADIOS_WORKSPACE_SOURCE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Risorsa eliminata.

Campi di risposta

CampoTipoDescrizione
messagestring

Esempio illustrativo; non è una risposta dal vivo:

{
  "message": "Deleted successfully"
}