Änderungsprotokoll für Projekt-API
In diesem Änderungsprotokoll finden Sie Informationen zu den neuesten Änderungen, Verbesserungen und Aktualisierungen für die Projekt-API. Das Änderungsprotokoll enthält eine Auflistung der vorgenommenen Änderungen in der zeitlichen Reihenfolge ihrer jeweiligen Freigabe. Änderungen an vorhandenen Versionen der Anwendungsprogrammierschnittstelle (API) sind so konzipiert, dass sie mit vorhandenen Clientanwendungen kompatibel sind.
03 April 2024
Projekt-API v1.0.0 ist jetzt verfügbar. Stellen Sie sicher, dass Sie Ihre Version von der Betaversion aktualisieren.
Die folgenden Änderungen wirken sich auf die Paginierung von list-Operationen aus. Weitere Informationen finden Sie im Abschnitt pagination der Projekte-API-Dokumente.
Listenprojekte
GET /v1/projects
- Der Abfrageparameter für Seitentoken wurde von
startintokenumbenannt.- Beispiel: Der Aufruf der Operation
list-projectswurde vonGET /v1/projects?limit=5&start={page_token}inGET /v1/projects?limit=5&token={page_token}geändert.
- Beispiel: Der Aufruf der Operation
- Die erste Seite wird ohne den Tokenabfrageparameter in der Anforderungs-URL zurückgegeben. Beispiel:
GET /v1/projects?limit=5oderGET /v1/projects.- Die erste Seite wird ebenfalls zurückgegeben, wenn das angegebene Seitentoken ungültig ist.
- Die Felder
lastundpreviouswerden nicht mehr unterstützt und nicht mehr in die Antwortnutzdaten eingeschlossen.
list-configs
GET /v1/projects/{project_id}/configs
- Diese Operation ist jetzt paginiert.
- Ein Standardwert von 10 Datensätzen wird zurückgegeben, wenn die Seitengröße nicht im Abfrageparameter
limitangegeben ist.- Die maximale Seitengröße beträgt 100 Datensätze.
- Die erste Seite wird ohne den Tokenabfrageparameter in der Anforderungs-URL zurückgegeben. Beispiel:
GET /v1/projects/{project_id}/configs/?limit=5oderGET /v1/projects/{project_id}/configs.- Die erste Seite wird ebenfalls zurückgegeben, wenn das angegebene Seitentoken ungültig ist.
Listenumgebungen
GET /v1/projects/{project_id}/environments
- Diese Operation ist jetzt paginiert.
- Es werden standardmäßig 10 Datensätze zurückgegeben, wenn die Seitengröße nicht im Abfrageparameter
limitangegeben ist.- Die maximale Seitengröße beträgt 100 Datensätze.
- Die erste Seite wird ohne den Abfrageparameter
tokenin der Anforderungs-URL zurückgegeben. Beispiel:GET /v1/projects/{project_id}/environments/?limit=5oderGET /v1/projects/{project_id}/environments.- Die erste Seite wird ebenfalls zurückgegeben, wenn das angegebene Seitentoken ungültig ist.
Methoden zur Unterstützung des Stapelns implementierbarer Architekturen
Experimentell
Es wurden experimentelle Methoden zur Unterstützung von stapelbaren implementierbaren Architekturen hinzugefügt.
06. November 2023
Die letzte Aktualisierung enthält die folgende unterbrechende Änderung:
- Die
configurationsresponse-Modelle für alle Methoden verwenden keinpipeline_statemehr. Alle Statusinformationen einesconfigurations sind in der erweiterten Eigenschaftstateim kanonischen Schema einesconfigurations verfügbar.
Änderungen an Projekten und Konfigurationen
create-project: POST /v1/projects
resource_groupundlocationmüssen jetzt in dierequest-Nutzdaten eingebettet werden. Sie werden nicht mehr als Abfrageparameter unterstützt.
delete-config: PATCH /v1/projects/{project_id}/configs/{id}
- Der Abfrageparameter
draft_onlyist veraltet. - Die API unterstützt jetzt das Löschen von
configurationeiner angegebenen Projekt-ID undversion. Siehe projects#delete-config-version.
Umbenannte Konfigurationsendpunkte
Die folgenden Konfigurationsendpunkte werden wie folgt umbenannt:
POST /v1/projects/{project_id}/configs/{id}/checkwird inPOST /v1/projects/{project_id}/configs/{id}/validategeändert.POST /v1/projects/{project_id}/configs/{id}/installwird inPOST /v1/projects/{project_id}/configs/{id}/deploygeändert.POST /v1/projects/{project_id}/configs/{id}/uninstallwird inPOST /v1/projects/{project_id}/configs/{id}/undeploygeändert.
Ersetzte Konfigurationsendpunkte
Die drafts-Methoden wurden wie folgt durch die versions-Operationen ersetzt:
GET /v1/projects/{project_id}/configs/{config_id}/draftswird inGET /v1/projects/{project_id}/configs/{id}/versionsgeändert.GET /v1/projects/{project_id}/configs/{config_id}/drafts/{version}wird geändert inGET /v1/projects/{project_id}/configs/{id}/versions/{version}
Konfigurationsstatus
Das Statusmodell für configurations ist abgeflacht. pipeline_state ist nicht mehr verfügbar und die Eigenschaft state wird jetzt erweitert, um alle möglichen Status eines configuration s
zu erfassen.
Im Folgenden sind die neuen state-Werte aufgeführt:
approveddeleteddeletingdeleting_faileddiscardeddeployeddeploying_faileddeployingsupercededundeployingundeploying_failedvalidatedvalidatingvalidating_failed
Alle configuration-Endpunkte enthalten diese Eigenschaft state im response-Modell. Ein Beispiel finden Sie unter projects#get-config-version-response.
Neue Metadaten für Konfiguration
Das response-Modell der configurations-Operationen definiert jetzt neue Metadaten im Stammverzeichnis. Wenn ein approve-Job auf einem configuration ausgeführt wurde, ist die Eigenschaft approved_version in den response-Nutzdaten enthalten. Wenn ein deploy-Job auf einem configuration ausgeführt wurde, sind die Metadaten deployed_version und last_deployed im Hauptteil von response verfügbar. Die Ausführung eines validation-Jobs liefert die Metadaten last_validated, während die Ausführung eines undeploy-Jobs die Metadaten last_undeployed in der response liefert.
25. Oktober 2023
In projects-und configurations-Operationen wie create und update müssen jetzt Definitionseigenschaften wie name und description in einem definition-Wrapper
bereitgestellt werden. In ähnlicher Weise sind diese Eigenschaften jetzt nur innerhalb eines definition-Blocks in den response-Nutzdaten von Operationen create, update, get und
list verfügbar. Dies ist eine bahnbrechende Änderung, die ursprünglich am 06. Juli 2023 veröffentlicht wurde. Die folgenden Abschnitte enthalten weitere Informationen zu den Methoden, die von dieser Aktualisierung betroffen sind.
Projekte
create-project: POST /v1/projects
- Für
request&responsewerdenname,descriptionunddestroy_on_deletejetzt in eindefinition-Objekt eingeschlossen. - Von den Aufrufenden dieses Endpunkts wird jetzt erwartet, dass sie die Definitionseigenschaften innerhalb dieses Wrappers bereitstellen. Beispiel:
definition: {“name”: “test”, “description”: “This is a test project”, “destroy_on_delete”: false}.- Wenn
destroy_on_deletenicht angegeben ist, wird bei einer Projekterstellungsoperation der Standardwerttruezugewiesen.
- Wenn
- Siehe Projekte#create-project-request.
- In ähnlicher Weise sind die zuvor genannten Eigenschaften im
response-Hauptteil jetzt in einemdefinition-Block verfügbar.
update-project: PATCH /v1/projects/{id}
- Für
request&responsewerdenname,descriptionunddestroy_on_deletejetzt in eindefinition-Objekt eingeschlossen. - Von den Aufrufenden dieses Endpunkts wird jetzt erwartet, dass sie die Definitionseigenschaften innerhalb dieses Wrappers bereitstellen. Beispiel:
definition: {“name”: “test_update”, “description”: “This is an updated test project“}.- Siehe Projekte#update-project-request.
- In ähnlicher Weise sind die zuvor genannten Eigenschaften im
response-Hauptteil jetzt in einemdefinition-Block verfügbar.
get-projects: GET /v1/projects/{id}
- In der
responsedieser Operation sind diename,descriptionunddestroy_on_deletejetzt in einemdefinition-Block eingeschlossen.
list-project: GET /v1/projects
- Jedes Projekt, das im Array
responsezurückgegeben wird, schließt die Eigenschaftenname,descriptionunddestroy_on_deletein einendefinition-Block ein.
Konfigurationen
create-config: POST /v1/projects/{project_id}/configs
- Für
request&responsewerdenlocator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionjetzt in eindefinition-Objekt eingeschlossen. - Von den Aufrufenden dieses Endpunkts wird jetzt erwartet, dass sie die Definitionseigenschaften innerhalb dieses Wrappers bereitstellen. Beispiel:
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- Siehe Projekte#create-config-request.
- In ähnlicher Weise sind die zuvor genannten Eigenschaften im
response-Hauptteil jetzt in einemdefinition-Block verfügbar.- Eine Eigenschaft
settingist auch im Blockdefinitionenthalten. - Siehe Projekte#create-config-response.
- Eine Eigenschaft
update-config: PATCH /v1/projects/{project_id}/configs/{id}
- Für
request&responsewerdenlocator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionjetzt in eindefinition-Objekt eingeschlossen. - Von den Aufrufenden dieses Endpunkts wird jetzt erwartet, dass sie die Definitionseigenschaften innerhalb dieses Wrappers bereitstellen. Beispiel:
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- Siehe Projekte#update-config-request.
- Ebenso werden im
response-Hauptteil die zuvor genannten Eigenschaften in einendefinition-Block verschoben.
get-config: GET /v1/projects/{id}
- In der
responsedieser Operation werden dielocator_id,name,labels,authorizations,compliance_profile,input,setting,descriptionundsettingjetzt in eindefinition-Objekt eingeschlossen.- Siehe Projekte#get-config-response.
list-configs: GET /v1/projects/{project_id}/configs
- In der
responsedieser Operation sindnameunddescriptionjetzt in eindefinition-Objekt eingeschlossen.
06. Juli 2023
Die Antwortmodelle für alle Methoden erzwingen jetzt ein niedrigeres Schlangenformat in state-Werten. Dieses Format wird in der Antwort erwartet, wenn Sie die Projekt-und Konfigurationsendpunkte aufrufen. Diese Aktualisierung ist
eine unterbrechende Änderung.
state-Projektwerte können jetzt ready, deleting und deleting_failed sein. Ein Beispiel finden Sie unter Antwortschema für die Methode update-project.
Die state-Konfigurationswerte können nun deleted, deleting, deleting_failed, installed, installed_failed, installing, not_installed, uninstalling,
uninstalling_failed und active sein. Ein Beispiel finden Sie unter Antwortschema für die Methode get-config.