Page MenuHomePhabricator
Create Task
Maniphest T432714

📜P1: make remaining GET endpoints for upcoming, current and all policies of a given type
Closed, ResolvedPublic
Actions

Description

Get upcoming policy version (ToU/HP)
GET /v1/policies/{policy_type}/upcoming

{
  "metadata": {
    "policy_id": 4
    "type": "terms-of-use",
    "active_from": "2028-11-02",
    "content_vue_file": "terms-of-use/version-3.vue"
  }
}

If there is no upcoming policy of this type we should return a 404.
If there are multiple upcoming policies (either with or without an active_from date) we should return a 500

Get the metadata of all policies (of a single type)
GET /v1/policies/{policy_type}

{ 
  "items": [
    {
      "metadata": {
        "policy_id": 1
   "type": "terms-of-use",
   "active_from": "2020-01-01",
   "content_vue_file": "terms-of-use/version-1.vue"
      }
    },
    {
      "metadata": {
        "policy_id": 4
        "type": "terms-of-use",
        "active_from": "2022-11-02",
        "content_vue_file": "terms-of-use/version-2.vue"
      }
    },
    {
      "metadata": {
        "policy_id": 5
        "type": "terms-of-use",
        "content_vue_file": "terms-of-use/version-3.vue"
      }
    },
    ...
  ]
}

If there are no policies of this type we should return an empty items array.

Get the reference to the metadata of the current policy version of a single type
GET /v1/policies/{policy_type}/current

{
  "metadata": {
    "policy_id": 3
    "type": "terms-of-use",
    "active_from": "2024-11-07",
    "content_vue_file": "terms-of-use/version-2.vue"
  }
}

If there is no current policy of this type we should return a 404.

PRs:

Related Objects
Search...

Event Timeline

dena created this task.Tue, Jul 21, 11:04 AM
dena renamed this task from P1: make remaining GET endpoints for upcoming, current and all policies of a given type to 📜P1: make remaining GET endpoints for upcoming, current and all policies of a given type.
dena mentioned this in T432340: 📜 P1: Add component to Render Policies.Tue, Jul 21, 12:59 PM
Tarrow mentioned this in T432965: 📜P1: Remove all hardcoded policy references in UI.Thu, Jul 23, 11:49 AM
Tarrow updated the task description. (Show Details)Thu, Jul 23, 2:35 PM
dena updated the task description. (Show Details)Thu, Jul 23, 2:46 PM
Tarrow moved this task from Waiting for Tech Breakdown to Todo on the Wikibase Cloud (Kanban Board) board.Thu, Jul 23, 2:48 PM
dang updated the task description. (Show Details)Thu, Jul 23, 2:51 PM
dena claimed this task.Fri, Jul 24, 7:16 AM
dena moved this task from Todo to Doing on the Wikibase Cloud (Kanban Board) board.
dena added a comment.EditedFri, Jul 24, 10:11 AM

Two observations:

1. api route order matters
this one works:

$router->get('v1/policies/current', ['uses' => 'PoliciesController@getCurrentPolicies']);
$router->get('v1/policies/{policy_type}', ['uses' => 'PoliciesController@getPoliciesByType']);

this one doesnt: v1/policies/{policy_type} swallows the later ones:

$router->get('v1/policies/{policy_type}', ['uses' => 'PoliciesController@getPoliciesByType']);
$router->get('v1/policies/current', ['uses' => 'PoliciesController@getCurrentPolicies']);

2. Explicit nulling of active_from
Due to our PolicyFactory implementation we *need* to set active_from to null if we want it to be not filled.
this works:

Policy::factory()->create([
    'policy_type' => 'terms-of-use',
    'active_from' => null,
]);

this fills with 'active_from' => now()

Policy::factory()->create([
    'policy_type' => 'terms-of-use',
]);
dena removed dena as the assignee of this task.Fri, Jul 24, 10:12 AM
dena moved this task from Doing to Waiting for Peer Review on the Wikibase Cloud (Kanban Board) board.
dena updated the task description. (Show Details)
dena added a comment.Fri, Jul 24, 11:05 AM

Just now I was wondering if the GET /v1/policies/{policy_type} endpoint should also contain upcoming policies - as per the example from the senior notes doc it seems the answer is "yes":

Get the metadata of all policies (of a single type)
GET /v1/policies/{policy_type}

{ 
  "items": [
    {
      "metadata": {
        "policy_id": 1
   "type": "hosting-policy",
   "active_from": "2023-12-25",
   "content_vue_file": "hosting-policy/version-1.vue"
      }
    },
    {
      "metadata": {
        "policy_id": 4
        "type": "terms-of-use",
        "active_from": "2028-11-02",
        "content_vue_file": "terms-of-use/version-3.vue"
      }
    },
    ...
  ]
}
dena claimed this task.Fri, Jul 24, 11:09 AM
dena moved this task from Waiting for Peer Review to Undergoing Deploy or Action on Staging on the Wikibase Cloud (Kanban Board) board.
dena added a comment.Fri, Jul 24, 11:23 AM

found a bug while trying this on staging; reverted.

if active_from is null it gets filled with todays date

App\Policy {#8325
  id: 3,
  policy_type: "terms-of-use",
  active_from: null,
  content_vue_file: "terms-of-use/version-2.vue",
  created_at: "2026-07-23 14:42:57",
  updated_at: "2026-07-23 14:42:57",
},
 $ curl -Ls https://www.wikibase.dev/api/v1/policies/terms-of-use/upcoming | jq
{
  "metadata": {
    "policy_id": 3,
    "type": "terms-of-use",
    "active_from": "2026-07-24",
    "content_vue_file": "terms-of-use/version-2.vue"
  }
}
dena updated the task description. (Show Details)Fri, Jul 24, 12:03 PM
dena updated the task description. (Show Details)Fri, Jul 24, 1:37 PM
dena added a comment.Fri, Jul 24, 1:43 PM

tests on staging:

0 15:42 » deer@wmde-102295 ~
 $ curl -Ls https://www.wikibase.dev/api/v1/policies/terms-of-use | jq
{
  "items": [
    {
      "metadata": {
        "policy_id": 3,
        "type": "terms-of-use",
        "active_from": null,
        "content_vue_file": "terms-of-use/version-2.vue"
      }
    },
    {
      "metadata": {
        "policy_id": 1,
        "type": "terms-of-use",
        "active_from": "2022-01-01",
        "content_vue_file": "terms-of-use/version-1.vue"
      }
    }
  ]
}
0 15:42 » deer@wmde-102295 ~
 $ curl -Ls https://www.wikibase.dev/api/v1/policies/terms-of-use/current | jq
{
  "metadata": {
    "policy_id": 1,
    "type": "terms-of-use",
    "active_from": "2022-01-01",
    "content_vue_file": "terms-of-use/version-1.vue"
  }
}
0 15:42 » deer@wmde-102295 ~
 $ curl -Ls https://www.wikibase.dev/api/v1/policies/terms-of-use/upcoming | jq
{
  "metadata": {
    "policy_id": 3,
    "type": "terms-of-use",
    "active_from": null,
    "content_vue_file": "terms-of-use/version-2.vue"
  }
}
dena moved this task from Undergoing Deploy or Action on Staging to Done on the Wikibase Cloud (Kanban Board) board.Fri, Jul 24, 1:46 PM
Ollie.Shotton_WMDE closed this task as Resolved.Tue, Aug 11, 8:42 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits