Registry API

Pobiera wpis z kolekcji po id

get

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

collectionstringRequired

nazwa kolekcji rejestru.

Example: user-preferences

idstringRequired

unikalny identyfikator wpisu w kolekcji.

Example: c3f9a7c2-6d61-4d35-9f8b-f3c9f1b8a111

Responses

200

Wpis rejestru. Jeśli wpis o podanym identyfikatorze nie istnieje, zwracane jest puste ciało odpowiedzi.

application/json

idstringOptional

unikalny identyfikator wpisu w kolekcji

Example: c3f9a7c2-6d61-4d35-9f8b-f3c9f1b8a111

datastringOptional

dane wpisu (dowolny ładunek zapisany jako tekst)

Example: {"theme":"dark","lang":"pl"}

versionstringOptional

aktualna wersja wpisu (generowana przy każdym zapisie)

Example: 9b1f4b8a-2c3d-4e5f-8a7b-1c2d3e4f5a6b

400

Niepoprawne dane wejściowe.

401

Brak lub niepoprawne uwierzytelnienie.

403

Brak uprawnień.

500

Błąd wewnętrzny serwera.

get/v1/{collection}/{id}

HTTPcURLJavaScriptPython

GET /api/registry/v1/{collection}/{id} HTTP/1.1
Host: localhost:8080
Authorization: Basic username:password
Accept: */*

{
  "id": "c3f9a7c2-6d61-4d35-9f8b-f3c9f1b8a111",
  "data": "{\"theme\":\"dark\",\"lang\":\"pl\"}",
  "version": "9b1f4b8a-2c3d-4e5f-8a7b-1c2d3e4f5a6b"
}

Tworzy nowy wpis w kolekcji lub nadpisuje istniejący

post

Zapisuje wpis w podanej kolekcji (upsert). Obsługuje optymistyczne blokowanie poprzez pole version:

• brak pola version (null) - zapis wymuszony, bez sprawdzania wersji,
• version puste, a wpis o danym id już istnieje - zapis odrzucony,
• version niezgodne z aktualnie zapisaną wersją wpisu - zapis odrzucony.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

collectionstringRequired

nazwa kolekcji rejestru.

Example: user-preferences

Body

application/json

idstringRequired

unikalny identyfikator wpisu w kolekcji

Example: c3f9a7c2-6d61-4d35-9f8b-f3c9f1b8a111

datastringOptional

dane wpisu (dowolny ładunek zapisany jako tekst)

Example: {"theme":"dark","lang":"pl"}

versionstring · nullableOptional

wersja wpisu na potrzeby optymistycznego blokowania. null - zapis wymuszony bez sprawdzania wersji; wartość musi być zgodna z aktualną wersją zapisanego wpisu.

Example: 9b1f4b8a-2c3d-4e5f-8a7b-1c2d3e4f5a6b

Responses

204

Wpis zapisany.

No content

400

Niepoprawne dane wejściowe.

application/json

401

Brak lub niepoprawne uwierzytelnienie.

403

Brak uprawnień.

500

Błąd wewnętrzny serwera.

post/v1/{collection}

HTTPcURLJavaScriptPython

POST /api/registry/v1/{collection} HTTP/1.1
Host: localhost:8080
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "id": "c3f9a7c2-6d61-4d35-9f8b-f3c9f1b8a111",
  "data": "{\"theme\":\"dark\",\"lang\":\"pl\"}"
}

Utworzenie nowego wpisuNadpisanie istniejącego wpisu (z wersją)

No content

Usuwa wpis z kolekcji po id

delete

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

collectionstringRequired

nazwa kolekcji rejestru.

Example: user-preferences

idstringRequired

unikalny identyfikator wpisu w kolekcji.

Example: c3f9a7c2-6d61-4d35-9f8b-f3c9f1b8a111

Responses

204

Wpis usunięty.

No content

400

Niepoprawne dane wejściowe.

401

Brak lub niepoprawne uwierzytelnienie.

403

Brak uprawnień.

404

Nie znaleziono wpisu.

500

Błąd wewnętrzny serwera.

delete/v1/{collection}/{id}

HTTPcURLJavaScriptPython

DELETE /api/registry/v1/{collection}/{id} HTTP/1.1
Host: localhost:8080
Authorization: Basic username:password
Accept: */*

No content