# Migracja do v2

Ten przewodnik wyjaśnia, jak migrować z V1 do V2, dla dotkniętych mikrousług.

# Zmiany w Usługach

# Zapytanie o usunięte elementy

Uzyskaj punkty końcowe, które umożliwiają zwrot usuniętych elementów, mają teraz dostępne następujące zapytania:

show_active - Flaga boolowska (domyślnie true), aby zwrócić elementy bez szkody (tj. Aktywne) w ciele odpowiedzi
show_deleted - Flaga boolowska (domyślnie false) Aby zwrócić usunięte elementy w ciele odpowiedzi.

Domyślnie aktywne elementy zostaną zwrócone tylko.

Aby zwrócić tylko usunięte elementy, poproś o wartość show_deleted true i show_active Wartość false.

Aby zwrócić zarówno elementy aktywne, jak i usunięte, poproś o wartość show_deleted true.

Uwaga: niektóre punkty końcowe zawierają tylko zapytanie show_deleted, ale zachowanie jest takie samo.

# Usługa komentarzy

Użyj tych notatek migracyjnych, aby pomóc przełączyć z v1 z comments-service-api na v2. Ten dokument powinien szczegółowo opisać wszystkie zmiany w wersjach.

# Przestarzałe punkty końcowe

Należy pamiętać, że wszystkie punkty końcowe w v1 tego interfejsu API są przestarzałe, więc użytkownicy muszą jak najszybciej zaktualizować do następnej dostępnej wersji

# Zmiany w punktach końcowych

Zmiany w każdym punkcie końcowym znajduje się poniżej. Jest to ustrukturyzowane w podobny sposób jak Dokumentacja API (opens new window) dla łatwości użytkowania.

Uwaga: Nie wszystkie punkty końcowe miały zmiany.

# Uwagi

# `GET /comments`

Zapytanie comment_id akceptuje teraz wiele identyfikatorów w tablicy, umożliwiając użytkownikom filtrowanie wielu komentarzy jednocześnie.

# `POST /comments`

Ten punkt końcowy akceptuje teraz szereg obiektów komentarzy w ciele żądania, umożliwiając użytkownikom publikowanie wielu komentarzy jednocześnie:

+ [
    {
        reference_id: "79b577e3-f11e-4b7e-b91d-65c501a0926d",
        reference_table: "assets",
        reference_url: "http://testapi.com/api/assets",
        content: "Test comment"
    }
+ ]

# Serwis danych odniesienia

Użyj tych notatek migracyjnych, aby pomóc przełączyć z v1 z reference-data-service-api na v2. Ten dokument powinien szczegółowo opisać wszystkie zmiany w wersjach.

# Przestarzałe punkty końcowe

Należy pamiętać, że wszystkie punkty końcowe w v1 tego interfejsu API są przestarzałe, więc użytkownicy muszą jak najszybciej zaktualizować do następnej dostępnej wersji

# Zmiany w punktach końcowych

Zmiany w każdym punkcie końcowym znajduje się poniżej. Jest to ustrukturyzowane w podobny sposób jak Dokumentacja API (opens new window) dla łatwości użytkowania.

Uwaga: Nie wszystkie punkty końcowe miały zmiany.

# Typy źródeł

# `GET /source_types`

Logika zapytania show_deleted została zaktualizowana. Proszę zobaczyć powyżej sekcji po więcej informacji.

# Źródła

# `GET /sources`

Logika zapytania show_deleted została zaktualizowana. Proszę zobaczyć powyżej sekcji po więcej informacji.

# Usługa QA

Użyj tych notatek migracyjnych, aby pomóc przełączyć z v1 z qa-data-service-api na v2. Ten dokument powinien szczegółowo opisać wszystkie zmiany w wersjach.

# Przestarzałe punkty końcowe

Należy pamiętać, że wszystkie punkty końcowe w v1 tego interfejsu API są przestarzałe, więc użytkownicy muszą jak najszybciej zaktualizować do następnej dostępnej wersji

# Zmiany w punktach końcowych

Zmiany w każdym punkcie końcowym znajduje się poniżej. Jest to ustrukturyzowane w podobny sposób jak Dokumentacja API (opens new window) dla łatwości użytkowania.

# Dokumentacja

# `POST /records`

Ten punkt końcowy został zaktualizowany, aby zaakceptować szereg rekordów w ciele żądania. Umożliwia to użytkownikom publikowanie wielu nowych rekordów jednocześnie:

+ [
    {
        "type_id": "f3f25a90-5caa-459a-ab8b-ab0a4dc20e42",
        "reference_id": "79b577e3-f11e-4b7e-b91d-65c501a0926d",
        "reference_table": "assets",
        "reference_url": "http://testapi.com/api/assets"
    }
+ ]

# Usługa kontekstu środowiska

Użyj tych notatek migracyjnych, aby pomóc przełączyć z v1 z comments-service-api na v2. Ten dokument powinien szczegółowo opisać wszystkie zmiany w wersjach.

# Przestarzałe punkty końcowe

Należy pamiętać, że wszystkie punkty końcowe w v1 tego interfejsu API są przestarzałe, więc użytkownicy muszą jak najszybciej zaktualizować do następnej dostępnej wersji

# Zmiany w punktach końcowych

Zmiany w każdym punkcie końcowym znajduje się poniżej. Jest to ustrukturyzowane w podobny sposób jak Dokumentacja API (opens new window) dla łatwości użytkowania.

Główne zmiany pochodzą z przełącznika API, teraz używamy ADS (ARUP Data Service), a nie CDS (Corporate Data Service)

Uwaga: Nie wszystkie punkty końcowe miały zmiany.

# Projektowanie

# `GET /projects & /ads/projects`

Klucze odpowiedzi zmieniły się

{
"projects": [
    {
    "centre_code": "509",
    "confidential": false,
-   "job_name_short": "V & A MUSEUM, DUNDEE",
+   "short_title": "V & A MUSEUM, DUNDEE",
-   "job_number": "216899",
-   "job_suffix": "00",
-   "project_code": "21689900",
+   "project_number": "21689900",
-   "organisation_name": "KENGO KUMA & ASSOCIATES",
+   "client_organisation_name": "KENGO KUMA & ASSOCIATES",
    "number": "21689900",
    "project_director_email": "[email protected]",
    "project_director_name": "User Name",
    "project_id": "ca1e89a5-780d-4dc9-96e9-41f3c7aaa810",
    "project_manager_email": "[email protected]",
    "project_manager_name": "User Name",
    "project_url": "http://projects.intranet.arup.com/?layout=projects.proj.view&jp=OA&jn=26190800",
    "scope_of_works": "A new waterfront museum for Dundee City Council"
    }
]
}

# `GET, PATCH /projects/{id} & POST /projects`

Klucze odpowiedzi zmieniły się

{
"project": {
    "centre_code": "509",
    "confidential": false,
-   "job_name_short": "V & A MUSEUM, DUNDEE",
+   "short_title": "V & A MUSEUM, DUNDEE",
-   "job_number": "216899",
-   "job_suffix": "00",
-   "project_code": "21689900",
+   "project_number": "21689900",
-   "organisation_name": "KENGO KUMA & ASSOCIATES",
+   "client_organisation_name": "KENGO KUMA & ASSOCIATES",
    "project_director_email": "[email protected]",
    "project_director_name": "User Name",
    "project_id": "ca1e89a5-780d-4dc9-96e9-41f3c7aaa810",
    "project_manager_email": "[email protected]",
    "project_manager_name": "User Name",
    "project_url": "http://projects.intranet.arup.com/?layout=projects.proj.view&jp=OA&jn=26190800",
    "scope_of_works": "A new waterfront museum for Dundee City Council."
    "created_at": "2019-05-10T13:45:08.000Z",
    "updated_at": "2019-05-10T13:45:08.000Z",
    "deleted_at": "2019-05-10T13:45:08.000Z"
    }
}

# Kraje

# `GET /countries`

Klucze odpowiedzi zmieniły się

{
  "countries": [
    {
      "country_class": "A",
      "country_code": "C163",
      "country_id": "64fde841-4950-e711-8104-005056b57459",
      "country_name": "Northern Ireland",
      "iso_code": "GB",
      "iso_country_name": "United Kingdom",
-     "iso_formal_country_name": "United Kingdom of Great Britain and Northern Ireland",
+     "iso_formal_name": "United Kingdom of Great Britain and Northern Ireland",
      "region": {
        "region_code": "B04",
        "region_id": "9c54bb0d-4950-e711-8104-005056b57459",
        "region_name": "UKIMEA Region",
-       "arup_region_level": 1,
-       "company_code": C01,
      }
    }
  ]
}

# Regiony

# `GET /regions`

Klucze odpowiedzi zmieniły się

{
  "regions": [
    {
      "region_code": "B04",
      "region_id": "9c54bb0d-4950-e711-8104-005056b57459",
      "region_name": "UKIMEA Region",
-     "arup_region_level": 1,
-     "company_code": C01,
    }
  ]
}

← Migracja do V1

# Migracja do v2

# Zmiany w Usługach

# Zapytanie o usunięte elementy

# Usługa komentarzy

# Przestarzałe punkty końcowe

# Zmiany w punktach końcowych

# Uwagi

# GET /comments

# POST /comments

# Serwis danych odniesienia

# Przestarzałe punkty końcowe

# Zmiany w punktach końcowych

# Typy źródeł

# GET /source_types

# Źródła

# GET /sources

# Usługa QA

# Przestarzałe punkty końcowe

# Zmiany w punktach końcowych

# Dokumentacja

# POST /records

# Usługa kontekstu środowiska

# Przestarzałe punkty końcowe

# Zmiany w punktach końcowych

# Projektowanie

# GET /projects & /ads/projects

# GET, PATCH /projects/{id} & POST /projects

# Kraje

# GET /countries

# Regiony

# GET /regions

# `GET /comments`

# `POST /comments`

# `GET /source_types`

# `GET /sources`

# `POST /records`

# `GET /projects & /ads/projects`

# `GET, PATCH /projects/{id} & POST /projects`

# `GET /countries`

# `GET /regions`