Aller au contenu
AdiosDocumentation
Parcourir la documentation

API des artefacts source

Lisez les métadonnées des instantanés de code source utilisés pour les compilations et le chargement des espaces de travail. Les artefacts sont créés par les processus d’envoi de code source et de compilation.

Utiliser Authentification API pour les requêtes protégées. Les exemples utilisent vos propres ID de ressources et un jeton temporaire ; les exemples de réponses enregistrés sont synthétiques.

MéthodeCheminOpération
GET/v1/source_artifactLister les artefacts sources
GET/v1/source_artifact/{id}Obtenir un artefact source

Lister les artefacts sources

GET /v1/source_artifact

Renvoie une liste paginée de SourceArtifact

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
pagerequêtenonNuméro de page
per_pagerequêtenonÉléments par page

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Réponse : HTTP 200

Liste de SourceArtifact

Champs de réponse

ChampTypeDescription
datatableau
data[].branchchaîne
data[].build_idchaîneCompilation produite à partir de cet instantané du code source
data[].commit_shachaîne
data[].content_typechaîne
data[].created_atentier(horodatage Unix)
data[].deleted_atentier(horodatage Unix)
data[].digestchaîneEmpreinte du contenu de l’archive source
data[].metadataobjet
data[].repository_urlchaîneURL du dépôt Git lorsque source_type est git
data[].size_bytesentier
data[].source_artifact_idchaîne
data[].source_typechaîneValeurs autorisées : upload, git, workspace, template, unknown.
data[].system_artifact_idchaîneIdentifiant de l’artefact objet du système pour l’archive source
data[].system_object_keychaîne
data[].system_urichaîne
data[].team_idchaîne
data[].updated_atentier(horodatage Unix)
data[].workload_idchaîne
paginationobjet
pagination.pageentierNuméro de page actuel
pagination.per_pageentierNombre d’éléments par page
pagination.totalentierNombre total d’éléments

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "data": [
    {
      "branch": "",
      "build_id": "example",
      "commit_sha": "",
      "content_type": "",
      "created_at": 1791072000,
      "deleted_at": 0,
      "digest": "",
      "metadata": {},
      "repository_url": "example",
      "size_bytes": 0,
      "source_artifact_id": "000000000000000000000000001",
      "source_type": "unknown",
      "system_artifact_id": "example",
      "system_object_key": "",
      "system_uri": "",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "workload_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Obtenir un artefact source

GET /v1/source_artifact/{id}

Renvoie un seul SourceArtifact

Définissez source_artifact_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Réponse : HTTP 200

SourceArtifact

Champs de réponse

ChampTypeDescription
branchchaîne
build_idchaîneCompilation produite à partir de cet instantané du code source
commit_shachaîne
content_typechaîne
created_atentier(horodatage Unix)
deleted_atentier(horodatage Unix)
digestchaîneEmpreinte du contenu de l’archive source
metadataobjet
repository_urlchaîneURL du dépôt Git lorsque source_type est git
size_bytesentier
source_artifact_idchaîne
source_typechaîneValeurs autorisées : upload, git, workspace, template, unknown.
system_artifact_idchaîneIdentifiant de l’artefact objet du système pour l’archive source
system_object_keychaîne
system_urichaîne
team_idchaîne
updated_atentier(horodatage Unix)
workload_idchaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "branch": "",
  "build_id": "example",
  "commit_sha": "",
  "content_type": "",
  "created_at": 1791072000,
  "deleted_at": 0,
  "digest": "",
  "metadata": {},
  "repository_url": "example",
  "size_bytes": 0,
  "source_artifact_id": "000000000000000000000000001",
  "source_type": "unknown",
  "system_artifact_id": "example",
  "system_object_key": "",
  "system_uri": "",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "workload_id": "000000000000000000000000001"
}