Git - Commit To Git

Usługa:
Core
Wersja interfejsu API:
v1

Zatwierdza zmiany wprowadzone w obszarze roboczym do połączonej gałęzi zdalnej.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aby można było używać tego interfejsu API, należy skonfigurować poświadczenia usługi Git elementu wywołującego przy użyciu interfejsu API Aktualizacji poświadczeń usługi Git . Aby sprawdzić konfigurację poświadczeń usługi Git, możesz użyć interfejsu API Uzyskiwanie poświadczeń usługi Git .

Możesz zatwierdzić wszystkie zmiany, określone elementy lub określone pliki w ramach elementów przy użyciu trybu FileLevelSelective. Aby zsynchronizować obszar roboczy po raz pierwszy, użyj tego interfejsu API po interfejsach API nawiązywania połączenia i inicjowania.

Uprawnienia

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Workspace.GitCommit.All.

Tożsamości obsługiwane przez Microsoft Entra

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
Główne usługi i Tożsamości zarządzane Obsługiwane tylko wtedy, gdy wszystkie elementy zaangażowane w operację obsługują jednostki usługi

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.

Treść żądania

Nazwa Wymagane Typ Opis
mode True

CommitMode

Tryb operacji zatwierdzania.
comment

string

maxLength: 300

Komentarz bez rozmówców dla tego zatwierdzenia. Maksymalna długość to 300 znaków. Jeśli obiekt wywołujący nie udostępni komentarza, użyj domyślnego komentarza dostawcy usługi Git.
items

ItemIdentifier[]

Określone elementy do zatwierdzenia. Dotyczy to tylko trybu zatwierdzania selektywnego. Wzajemnie wykluczające się elementyWithFileSelection. Elementy można pobrać z interfejsu API stanu usługi Git .
itemsWithFileSelection

ItemIdentifierWithFileSelection[]

Elementy z wyborem poszczególnych plików dla trybu zatwierdzania FileLevelSelective. Wzajemnie wykluczające się elementy. Każdy wpis określa element i opcjonalnie listę ścieżek plików do zatwierdzenia. Jeśli element selectedFiles ma wartość null lub jest pusty, wszystkie pliki dla tego elementu są zatwierdzane.
workspaceHead

string

Pełny skrót SHA synchronizowany z obszarem roboczym. Skrót można pobrać z interfejsu API stanu usługi Git .

Odpowiedzi

Nazwa Typ Opis
200 OK

Żądanie zostało ukończone pomyślnie.
202 Accepted

Żądanie zaakceptowane, zatwierdzenie w toku usługi Git.

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • WorkspaceNotConnectedToGit — obszar roboczy nie jest połączony z usługą git.

  • WorkspaceHasNoCapacityAssigned — brak pojemności assinged do obszaru roboczego.

  • WorkspaceHeadMismatch — nagłówek w żądaniu nie pasuje do nagłówka w systemie.

  • WorkspacePreviousOperationInProgress — poprzednia operacja jest nadal w toku.

  • InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień obszaru roboczego.

  • PrincipalTypeNotSupported — typ tożsamości obiektu wywołującego nie jest obsługiwany.

Przykłady

Commit all to Git example
Commit file-level selective to Git example
Commit selective items to Git example

Commit all to Git example

Przykładowe żądanie

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."
}

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
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

Przykładowe żądanie

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": []
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
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

Przykładowe żądanie

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"
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
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

Definicje

Nazwa Opis
CommitMode

Tryby operacji zatwierdzania. Dodatkowe tryby mogą być dodawane w czasie.
CommitToGitRequest

Zawiera żądanie zatwierdzenia.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
ItemIdentifier

Zawiera identyfikator elementu. Należy zdefiniować co najmniej jedną z właściwości.
ItemIdentifierWithFileSelection

Zawiera identyfikator elementu z opcjonalnym wyborem na poziomie pliku dla operacji zatwierdzania.

CommitMode

Wyliczenie

Tryby operacji zatwierdzania. Dodatkowe tryby mogą być dodawane w czasie.

Wartość Opis
All

Zatwierdź wszystkie niezatwierdzone zmiany. Obiekt wywołujący nie jest wymagany do udostępnienia listy elementów do zatwierdzenia.
Selective

Zatwierdź określoną listę elementów, które mają niezatwierdzone zmiany. items Użyj właściwości , aby określić elementy.
FileLevelSelective

Zatwierdź określone pliki w określonych elementach. itemsWithFileSelection Użyj właściwości , aby określić elementy i pliki.

CommitToGitRequest

Objekt

Zawiera żądanie zatwierdzenia.

Nazwa Typ Opis
comment

string

maxLength: 300

Komentarz bez rozmówców dla tego zatwierdzenia. Maksymalna długość to 300 znaków. Jeśli obiekt wywołujący nie udostępni komentarza, użyj domyślnego komentarza dostawcy usługi Git.
items

ItemIdentifier[]

Określone elementy do zatwierdzenia. Dotyczy to tylko trybu zatwierdzania selektywnego. Wzajemnie wykluczające się elementyWithFileSelection. Elementy można pobrać z interfejsu API stanu usługi Git .
itemsWithFileSelection

ItemIdentifierWithFileSelection[]

Elementy z wyborem poszczególnych plików dla trybu zatwierdzania FileLevelSelective. Wzajemnie wykluczające się elementy. Każdy wpis określa element i opcjonalnie listę ścieżek plików do zatwierdzenia. Jeśli element selectedFiles ma wartość null lub jest pusty, wszystkie pliki dla tego elementu są zatwierdzane.
mode

CommitMode

Tryb operacji zatwierdzania.
workspaceHead

string

Pełny skrót SHA synchronizowany z obszarem roboczym. Skrót można pobrać z interfejsu API stanu usługi Git .

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

ItemIdentifier

Objekt

Zawiera identyfikator elementu. Należy zdefiniować co najmniej jedną z właściwości.

Nazwa Typ Opis
logicalId

string (uuid)

Identyfikator logiczny elementu. Jeśli identyfikator logiczny jest niedostępny, ponieważ element nie został jeszcze dodany do obszaru roboczego, możesz użyć identyfikatora obiektu.
objectId

string (uuid)

Identyfikator obiektu elementu. Jeśli identyfikator obiektu jest niedostępny, ponieważ element został usunięty z obszaru roboczego, możesz użyć identyfikatora logicznego.

ItemIdentifierWithFileSelection

Objekt

Zawiera identyfikator elementu z opcjonalnym wyborem na poziomie pliku dla operacji zatwierdzania.

Nazwa Typ Opis
logicalId

string (uuid)

Identyfikator logiczny elementu. Jeśli identyfikator logiczny jest niedostępny, ponieważ element nie został jeszcze dodany do obszaru roboczego, możesz użyć identyfikatora obiektu.
objectId

string (uuid)

Identyfikator obiektu elementu. Jeśli identyfikator obiektu jest niedostępny, ponieważ element został usunięty z obszaru roboczego, możesz użyć identyfikatora logicznego.
selectedFiles

string[]

Ścieżki plików do zatwierdzenia względem katalogu głównego elementu. Ścieżki używają tylko ukośników do przodu, bez wiodącego ukośnika, tylko pełnych ścieżek plików (bez katalogów ani symboli wieloznacznych), nie ma pustych ani białych segmentów, a segmenty nie mogą kończyć się kropką ani końcowymi odstępami. Jeśli wartość null lub jest pusta, wszystkie pliki dla tego elementu zostaną zatwierdzone.