Git - Commit To Git

Služba:: Core

Verze rozhraní API:: v1

Potvrdí změny provedené v pracovním prostoru do připojené vzdálené větve.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud chcete toto rozhraní API použít, musí být přihlašovací údaje Git volajícího nakonfigurované pomocí rozhraní UPDATE MY Git CREDENTIALS API. Ke kontrole konfigurace přihlašovacích údajů Gitu můžete použít rozhraní API Získat moje přihlašovací údaje Gitu .

Pomocí režimu FileLevelSelective můžete potvrdit všechny změny, konkrétní položky nebo konkrétní soubory v rámci položek. Pokud chcete pracovní prostor synchronizovat poprvé, použijte toto rozhraní API po připojení a inicializaci rozhraní API připojení.

Dovolení

Volající musí mít roli přispěvatele nebo vyšší roli pracovního prostoru.

Požadované delegovaná rozsahy

Workspace.GitCommit.All.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
Hlavní služba a Spravované identity	Podporováno pouze v případech, kdy všechny položky zahrnuté v operaci podporují instanční objekty.

Rozhraní

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/commitToGit

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Vyžadováno	Typ	Description
mode	True	CommitMode	Režim operace potvrzení.
comment		string maxLength: 300	Komentář bez volajícího pro toto potvrzení Maximální délka je 300 znaků. Pokud volající neposkytuje žádný komentář, použijte výchozí komentář poskytovatele Gitu.
items		ItemIdentifier[]	Konkrétní položky, které se mají potvrdit To je relevantní pouze pro režim selektivního potvrzení. Vzájemně se vylučují s itemsWithFileSelection. Položky je možné načíst z rozhraní GIT Status API.
itemsWithFileSelection		ItemIdentifierWithFileSelection[]	Položky s výběrem jednotlivých souborů pro režim potvrzení FileLevelSelective. Vzájemně se vylučují s položkami. Každá položka určuje položku a volitelně seznam cest k souborům, které se mají potvrdit. Pokud je selectedFiles pro položku null nebo prázdná, všechny soubory pro danou položku jsou potvrzeny.
workspaceHead		string	Úplná hodnota hash SHA, se kterou se pracovní prostor synchronizuje. Hodnotu hash je možné načíst z rozhraní GIT Status API.

Odpovědi

Name	Typ	Description
200 OK		Žádost byla úspěšně dokončena.
202 Accepted		Žádost byla přijata a potvrzena do Gitu. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující `Retry-After` , jak dlouho musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: WorkspaceNotConnectedToGit – Pracovní prostor není připojený k Gitu. WorkspaceHasNoCapacityAssigned – Žádná kapacita není přiřazena k pracovnímu prostoru. WorkspaceHeadMismatch – Hlavička v požadavku neodpovídá hlavičce v systému. WorkspacePreviousOperationInProgress – Probíhá předchozí operace. InsufficientPrivileges – Volající nemá dostatečná oprávnění pracovního prostoru. PrincipalTypeNotSupported – Typ identity volajícího není podporován.

Příklady

Commit all to Git example

Commit file-level selective to Git example

Commit selective items to Git example

Commit all to Git example

Ukázkový požadavek

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/commitToGit

{
  "mode": "All",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing all my changes."
}

Ukázková odpověď

Stavový kód:: 200

Stavový kód:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Commit file-level selective to Git example

Ukázkový požadavek

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/commitToGit

{
  "mode": "FileLevelSelective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "Commit only the metadata change from MyNotebook",
  "itemsWithFileSelection": [
    {
      "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573",
      "selectedFiles": [
        "metadata.json"
      ]
    },
    {
      "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789",
      "selectedFiles": []
    }
  ]
}

Ukázková odpověď

Stavový kód:: 200

Stavový kód:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Commit selective items to Git example

Ukázkový požadavek

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/1565e6a3-c020-4c0c-dda7-92bafe99eec5/git/commitToGit

{
  "mode": "Selective",
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "comment": "I'm committing specific changes.",
  "items": [
    {
      "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
      "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
    },
    {
      "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
    }
  ]
}

Ukázková odpověď

Stavový kód:: 200

Stavový kód:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definice

Name	Description
CommitMode	Režimy operace potvrzení V průběhu času je možné přidat další režimy.
CommitToGitRequest	Obsahuje žádost o potvrzení.
ErrorParameter	Strukturovaný parametr poskytující další strojově čitelný kontext chyby.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ItemIdentifier	Obsahuje identifikátor položky. Musí být definována alespoň jedna z vlastností.
ItemIdentifierWithFileSelection	Obsahuje identifikátor položky s volitelným výběrem na úrovni souboru pro operace potvrzení.

CommitMode

Výčet

Režimy operace potvrzení V průběhu času je možné přidat další režimy.

Hodnota	Description
All	Potvrďte všechny nepotvrzené změny. Volající není nutný k zadání seznamu položek k potvrzení.
Selective	Potvrďte zadaný seznam položek, které mají nepotvrzené změny. `items` K určení položek použijte vlastnost.
FileLevelSelective	Potvrzení zadaných souborů v rámci zadaných položek `itemsWithFileSelection` Pomocí vlastnosti můžete zadat položky a soubory.

CommitToGitRequest

Objekt

Obsahuje žádost o potvrzení.

Name	Typ	Description
comment	string maxLength: 300	Komentář bez volajícího pro toto potvrzení Maximální délka je 300 znaků. Pokud volající neposkytuje žádný komentář, použijte výchozí komentář poskytovatele Gitu.
items	ItemIdentifier[]	Konkrétní položky, které se mají potvrdit To je relevantní pouze pro režim selektivního potvrzení. Vzájemně se vylučují s itemsWithFileSelection. Položky je možné načíst z rozhraní GIT Status API.
itemsWithFileSelection	ItemIdentifierWithFileSelection[]	Položky s výběrem jednotlivých souborů pro režim potvrzení FileLevelSelective. Vzájemně se vylučují s položkami. Každá položka určuje položku a volitelně seznam cest k souborům, které se mají potvrdit. Pokud je selectedFiles pro položku null nebo prázdná, všechny soubory pro danou položku jsou potvrzeny.
mode	CommitMode	Režim operace potvrzení.
workspaceHead	string	Úplná hodnota hash SHA, se kterou se pracovní prostor synchronizuje. Hodnotu hash je možné načíst z rozhraní GIT Status API.

ErrorParameter

Objekt

Strukturovaný parametr poskytující další strojově čitelný kontext chyby.

Name	Typ	Description
message	string	Popis významu parametru čitelný člověkem.
name	string	Identifikátor parametru.
value	string	Hodnota parametru.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable	boolean	Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky `Retry-After` odpovědi určete zpoždění, pokud je k dispozici.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
parameters	ErrorParameter[]	Strukturované parametry poskytují další strojově čitelný kontext chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
parameters	ErrorParameter[]	Strukturované parametry poskytují další strojově čitelný kontext chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

ItemIdentifier

Objekt

Obsahuje identifikátor položky. Musí být definována alespoň jedna z vlastností.

Name	Typ	Description
logicalId	string (uuid)	Logické ID položky. Pokud logické ID není k dispozici, protože položka ještě není přidána do pracovního prostoru, můžete použít ID objektu.
objectId	string (uuid)	ID objektu položky. Pokud ID objektu není k dispozici, protože položka byla odstraněna z pracovního prostoru, můžete použít logické ID.

ItemIdentifierWithFileSelection

Objekt

Obsahuje identifikátor položky s volitelným výběrem na úrovni souboru pro operace potvrzení.

Name	Typ	Description
logicalId	string (uuid)	Logické ID položky. Pokud logické ID není k dispozici, protože položka ještě není přidána do pracovního prostoru, můžete použít ID objektu.
objectId	string (uuid)	ID objektu položky. Pokud ID objektu není k dispozici, protože položka byla odstraněna z pracovního prostoru, můžete použít logické ID.
selectedFiles	string[]	Cesty k souborům k potvrzení vzhledem ke kořenovému adresáři položky Cesty používají pouze lomítka, žádné počáteční lomítko, pouze úplné cesty k souborům (žádné adresáře ani zástupné znaky), žádné prázdné nebo prázdné segmenty a segmenty nemohou končit tečkou ani koncovými prázdnými znaky. Pokud je hodnota null nebo prázdná, potvrdí se všechny soubory pro tuto položku.