• updates schema to include deprecation attribute in metric availabilitylatest825Docscf3f3672021-12-14 11:10

  Change detail

  15 changes across 2 operations and 1 model

  AllBreakingWarningInfo

  • GET/metric_availability/{area_type}/{area_code}
    • breaking

      removed the required property items/category from the response with the 200 status

    • breaking

      removed the required property items/last_update from the response with the 200 status

    • breaking

      removed the required property items/metric_name from the response with the 200 status

    • breaking

      removed the required property items/tags from the response with the 200 status

    • warning

      removed the optional property items/doc_last_modified from the response with the 200 status

    • info

      the response property items/deprecated became required for the status 200

    • info

      added the required property items/last_updated to the response with the 200 status

  View all changes (15)
• adds applicable_to to relevant schema22Docs666a1872021-11-30 11:57

  Change detail

  4 changes across 3 operations

  AllBreakingWarningInfo

  • GET/change_logs/{date}
    • breaking

      for the query request parameter page, default value 1 was added

    • info

      added the required property data/items/applicable_to to the response with the 200 status

  • GET/log_banners/{date}/{page}/{area_type}/{area_name}
    • breaking

      added the new required query request parameter page

  • GET/change_logs
    • info

      added the required property data/items/applicable_to to the response with the 200 status

• adds `doc_last_modified` attribute to metrics payload3Docs163e9552021-11-24 12:38

  Change detail

  3 changes across 3 operations

  AllBreakingWarningInfo

  • GET/metric_availability/{area_type}/{area_code}
    • info

      added the optional property items/doc_last_modified to the response with the 200 status

  • GET/metric_availability/{area_type}
    • info

      added the optional property items/doc_last_modified to the response with the 200 status

  • GET/metrics
    • info

      added the optional property items/doc_last_modified to the response with the 200 status

• integrates `exact` flag in definitions + minor correction2Docs8dd96332021-11-24 10:50

  Change detail

  2 changes across 2 operations

  AllBreakingWarningInfo

  • GET/metrics/{metric}/doc
    • info

      endpoint added

  • GET/metrics
    • info

      added the new optional query request parameter exact

• Merge remote-tracking branch 'origin/apidoc-changes' into development36187Docs94f7e832021-11-22 10:55

  Change detail

  61 changes across 18 operations

  AllBreakingWarningInfo

  • GET/metric_availability/{area_type}/{area_code}
    • breaking

      the mandatory response header phe-website-request removed for the status 200

    • breaking

      the mandatory response header x-phe-media-type removed for the status 200

    • warning

      the optional response header phe-server-loc removed for the status 200

    • info

      added the optional property items/deprecated to the response with the 200 status

    • info

      added the required property items/last_update to the response with the 200 status

  • GET/metric_availability/{area_type}
    • breaking

      the mandatory response header phe-website-request removed for the status 200

    • breaking

      the mandatory response header x-phe-media-type removed for the status 200

  View all changes (61)
• updates metrics documentation41211Docs6c6285e2021-11-15 12:11
• adds metrics doc endpoint and schema3Docs0cfcf322021-11-22 11:15
• update schema and payloads + changes PHE to UKHSA361814Docs81b7eaf2021-11-22 10:51
• Updates query to include nhsRegion / nhsTrust, updates test and openapi definitions45Docs70e0ae62021-11-10 13:56
• Corrects dropdowns for SOA and housekeeping27Docs7b3d29b2021-11-08 10:44
• fixes error and adds example response and schema1Docsd484da02021-09-20 13:53
• adds openapi definition1Docs6f733432021-09-20 13:33
• corrects typono API changesDocs222bb292021-08-24 13:55
• Merge remote-tracking branch 'origin/development' into development18Docsde32cf12021-08-24 09:51
• updates names and description47Docs478e5d82021-08-24 09:51
• removes authorisation4Docs76c02702021-08-23 12:30
• adds examples and description for change logs components14Docsa42d8882021-08-23 11:00
• adds 200 code response examples/schemas15Docs48119252021-08-17 15:35
• updates definitions & adds attrs1960Docse98bc092021-08-17 09:43
• renames file + adds more attrs + minor correctionsDocs59bcc0e2021-08-14 10:15

Revisions go back to the API's first capture.