Expose project_id on /api/v4/pages/domains

changelogs/unreleased/api-domains-expose-project_id.yml

@@ -0,0 +1,5 @@
+---
+title: Expose project_id on /api/v4/pages/domains
+merge_request: 16200
+author: Luc Didry
+type: changed

doc/api/pages_domains.md

@@ -21,6 +21,7 @@ curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/a
   {
     "domain": "ssl.domain.example",
     "url": "https://ssl.domain.example",
+    "project_id": 1337,
     "certificate": {
       "expired": false,
       "expiration": "2020-04-12T14:32:00.000Z"

lib/api/entities.rb

@@ -1133,6 +1133,7 @@ module API
     class PagesDomainBasic < Grape::Entity
       expose :domain
       expose :url
+      expose :project_id
       expose :certificate,
         as: :certificate_expiration,
         if: ->(pages_domain, _) { pages_domain.certificate? },

spec/fixtures/api/schemas/public_api/v4/pages_domain/basic.json

@@ -3,6 +3,7 @@
   "properties": {
     "domain": { "type": "string" },
     "url": { "type": "uri" },
+    "project_id": { "type": "integer" },
     "certificate_expiration": {
       "type": "object",
       "properties": {
@@ -13,6 +14,6 @@
       "additionalProperties": false
     }
   },
-  "required": ["domain", "url"],
+  "required": ["domain", "url", "project_id"],
   "additionalProperties": false
 }

spec/requests/api/pages_domains_spec.rb

@@ -46,6 +46,7 @@ describe API::PagesDomains do
           expect(json_response).to be_an Array
           expect(json_response.size).to eq(3)
           expect(json_response.last).to have_key('domain')
+          expect(json_response.last).to have_key('project_id')
           expect(json_response.last).to have_key('certificate_expiration')
           expect(json_response.last['certificate_expiration']['expired']).to be true
           expect(json_response.first).not_to have_key('certificate_expiration')