{ "openapi": "3.1.0", "info": { "title": "Bluereform Admin API", "version": "1.0.0", "description": "Bluereform Admin APIs - contains administrative backoffice services, metrics, and operations." }, "servers": [ { "url": "https:\/\/api.bluereformnetwork.org\/api\/v1\/admin" } ], "security": [ { "http": [] } ], "paths": { "\/pages\/about\/publish-status": { "patch": { "operationId": "admin.pages.about.publish-status.update", "summary": "Update publish status for the About Page", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.about.publish-status.update.post", "summary": "Update publish status for the About Page", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pages\/about\/section-1": { "get": { "operationId": "admin.pages.about.section-1.show", "summary": "Get Section 1 (Page Header) data for admin backoffice", "tags": [ "AboutPage" ], "responses": { "200": { "description": "`AboutPageSectionOneResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AboutPageSectionOneResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.about.section-1.update", "summary": "Update Section 1 (Page Header) in admin backoffice", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateAboutPageSectionOneRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page section 1 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionOneResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/about\/section-2": { "get": { "operationId": "admin.pages.about.section-2.show", "summary": "Get Section 2 (Our Story Section) data for admin backoffice", "tags": [ "AboutPage" ], "responses": { "200": { "description": "`AboutPageSectionTwoResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AboutPageSectionTwoResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.about.section-2.update", "summary": "Update Section 2 (Our Story Section) in admin backoffice", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateAboutPageSectionTwoRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page section 2 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionTwoResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/about\/section-3": { "get": { "operationId": "admin.pages.about.section-3.show", "summary": "Get Section 3 (Our Foundation: Mission, Vision & Values) data for admin backoffice", "tags": [ "AboutPage" ], "responses": { "200": { "description": "`AboutPageSectionThreeResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AboutPageSectionThreeResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.about.section-3.update", "summary": "Update Section 3 (Our Foundation: Mission, Vision & Values) in admin backoffice", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateAboutPageSectionThreeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page section 3 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionThreeResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/about\/section-4": { "get": { "operationId": "admin.pages.about.section-4.show", "summary": "Get Section 4 (Our Principles Section) data for admin backoffice", "tags": [ "AboutPage" ], "responses": { "200": { "description": "`AboutPageSectionFourResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AboutPageSectionFourResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.about.section-4.update", "summary": "Update Section 4 (Our Principles Section) in admin backoffice", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateAboutPageSectionFourRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page section 4 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionFourResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/about\/section-5": { "get": { "operationId": "admin.pages.about.section-5.show", "summary": "Get Section 5 (Our Methodology) data for admin backoffice", "tags": [ "AboutPage" ], "responses": { "200": { "description": "`AboutPageSectionFiveResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AboutPageSectionFiveResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.about.section-5.update", "summary": "Update Section 5 (Our Methodology) in admin backoffice", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateAboutPageSectionFiveRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page section 5 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionFiveResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/about\/section-6": { "get": { "operationId": "admin.pages.about.section-6.show", "summary": "Get Section 6 (Our People) data for admin backoffice", "tags": [ "AboutPage" ], "responses": { "200": { "description": "`AboutPageSectionSixResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/AboutPageSectionSixResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.about.section-6.update", "summary": "Update Section 6 (Our People) header in admin backoffice", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateAboutPageSectionSixRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "About page section 6 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionSixResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/about\/section-6\/leaders": { "post": { "operationId": "admin.pages.about.section-6.leaders.store", "summary": "Add a leader in Section 6", "tags": [ "AboutPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/StoreAboutPageSectionSixLeaderRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Leader added successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionSixLeaderResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/about\/section-6\/leaders\/{id}": { "post": { "operationId": "admin.pages.about.section-6.leaders.update", "summary": "Update an existing leader in Section 6", "tags": [ "AboutPage" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateAboutPageSectionSixLeaderRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Leader updated successfully." }, "data": { "$ref": "#\/components\/schemas\/AboutPageSectionSixLeaderResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "admin.pages.about.section-6.leaders.destroy", "summary": "Delete a leader in Section 6", "tags": [ "AboutPage" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Leader deleted successfully." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/auth\/login": { "post": { "operationId": "admin.auth.login", "description": "Authenticates an administrator using email, password, and optional keep-me-signed-in.", "summary": "Admin login", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdminLoginRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Admin sign in successful." }, "token_type": { "type": "string", "const": "Bearer" }, "access_token": { "type": "string" }, "admin": { "$ref": "#\/components\/schemas\/AdminResource" } }, "required": [ "message", "token_type", "access_token", "admin" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/auth\/logout": { "post": { "operationId": "admin.auth.logout", "description": "Revokes the active access token for the currently authenticated administrator.", "summary": "Admin logout", "tags": [ "Auth" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Admin session terminated successfully." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/auth\/change-password": { "post": { "operationId": "admin.auth.change-password", "description": "Allows an authenticated administrator to change their account password.", "summary": "Change admin password", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChangePasswordRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Password updated successfully." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/contact\/publish-status": { "patch": { "operationId": "admin.pages.contact.publish-status.update", "summary": "Update publish status for the Contact Page", "tags": [ "ContactPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.contact.publish-status.update.post", "summary": "Update publish status for the Contact Page", "tags": [ "ContactPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pages\/contact\/section-1": { "get": { "operationId": "admin.pages.contact.section-1.show", "summary": "Get Section 1 (Page Header) data for admin backoffice", "tags": [ "ContactPage" ], "responses": { "200": { "description": "`ContactPageSectionOneResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ContactPageSectionOneResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.contact.section-1.update", "summary": "Update Section 1 (Page Header) in admin backoffice", "tags": [ "ContactPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateContactPageSectionOneRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact page section 1 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/ContactPageSectionOneResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/contact\/section-2": { "get": { "operationId": "admin.pages.contact.section-2.show", "summary": "Get Section 2 (Get Involved) data for admin backoffice", "tags": [ "ContactPage" ], "responses": { "200": { "description": "`ContactPageSectionTwoResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ContactPageSectionTwoResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.contact.section-2.update", "summary": "Update Section 2 (Get Involved) in admin backoffice", "tags": [ "ContactPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateContactPageSectionTwoRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact page section 2 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/ContactPageSectionTwoResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/contact\/section-3": { "get": { "operationId": "admin.pages.contact.section-3.show", "summary": "Get Section 3 (A Simple Process) data for admin backoffice", "tags": [ "ContactPage" ], "responses": { "200": { "description": "`ContactPageSectionThreeResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ContactPageSectionThreeResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.contact.section-3.update", "summary": "Update Section 3 (A Simple Process) in admin backoffice", "tags": [ "ContactPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateContactPageSectionThreeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact page section 3 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/ContactPageSectionThreeResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/dashboard": { "get": { "operationId": "admin.dashboard", "summary": "Get consolidated data for the CMS Admin Dashboard", "tags": [ "Dashboard" ], "responses": { "200": { "description": "`DashboardResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/DashboardResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/dashboard\/recent-updates": { "get": { "operationId": "admin.dashboard.recent-updates", "summary": "Get paginated recent content updates", "tags": [ "Dashboard" ], "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 15 } } ], "responses": { "200": { "description": "Paginated set of `ContentActivityLogResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContentActivityLogResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pages\/home\/publish-status": { "patch": { "operationId": "admin.pages.home.publish-status.update", "summary": "Update publish status for the Home Page", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.publish-status.update.post", "summary": "Update publish status for the Home Page", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pages\/home\/section-1": { "get": { "operationId": "admin.pages.home.section-1.show", "summary": "Get Section 1 (Hero Section) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionOneResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionOneResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-1.update", "summary": "Update Section 1 (Hero Section) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionOneRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 1 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionOneResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-2": { "get": { "operationId": "admin.pages.home.section-2.show", "summary": "Get Section 2 (About Us Section) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionTwoResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionTwoResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-2.update", "summary": "Update Section 2 (About Us Section) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionTwoRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 2 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionTwoResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-3": { "get": { "operationId": "admin.pages.home.section-3.show", "summary": "Get Section 3 (Why we exist Section) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionThreeResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionThreeResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-3.update", "summary": "Update Section 3 (Why we exist Section) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionThreeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 3 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionThreeResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-4": { "get": { "operationId": "admin.pages.home.section-4.show", "summary": "Get Section 4 (Areas of work Section) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionFourResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionFourResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-4.update", "summary": "Update Section 4 (Areas of work Section) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionFourRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 4 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionFourResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-5": { "get": { "operationId": "admin.pages.home.section-5.show", "summary": "Get Section 5 (Before you submit a concern) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionFiveResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionFiveResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-5.update", "summary": "Update Section 5 (Before you submit a concern) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionFiveRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 5 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionFiveResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-6": { "get": { "operationId": "admin.pages.home.section-6.show", "summary": "Get Section 6 (People | Integrity | Accountability | Change) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionSixResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionSixResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-6.update", "summary": "Update Section 6 (People | Integrity | Accountability | Change) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionSixRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 6 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionSixResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-6\/actions": { "get": { "operationId": "admin.pages.home.section-6.actions.index", "summary": "Get Section 6 action popups list for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HomePageSectionSixActionResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pages\/home\/section-6\/actions\/{idOrKey}": { "get": { "operationId": "admin.pages.home.section-6.actions.show", "summary": "Get a specific Section 6 action popup by ID or key", "tags": [ "HomePage" ], "parameters": [ { "name": "idOrKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionSixActionResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-6.actions.update", "summary": "Update a specific Section 6 action popup by ID or key", "tags": [ "HomePage" ], "parameters": [ { "name": "idOrKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionSixActionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Section 6 action popup updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionSixActionResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "put": { "operationId": "admin.pages.home.section-6.actions.update.put", "summary": "Update a specific Section 6 action popup by ID or key", "tags": [ "HomePage" ], "parameters": [ { "name": "idOrKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionSixActionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Section 6 action popup updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionSixActionResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-7": { "get": { "operationId": "admin.pages.home.section-7.show", "summary": "Get Section 7 (Banner Section) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionSevenResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionSevenResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-7.update", "summary": "Update Section 7 (Banner Section) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionSevenRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 7 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionSevenResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-8": { "get": { "operationId": "admin.pages.home.section-8.show", "summary": "Get Section 8 (FAQ Section) data for admin backoffice", "tags": [ "HomePage" ], "responses": { "200": { "description": "`HomePageSectionEightResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/HomePageSectionEightResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.home.section-8.update", "summary": "Update Section 8 (FAQ Section) in admin backoffice", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionEightRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Home page section 8 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionEightResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-8\/faqs": { "post": { "operationId": "admin.pages.home.section-8.faqs.store", "summary": "Add a FAQ to Section 8", "tags": [ "HomePage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreHomePageSectionEightFaqRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "FAQ added successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionEightFaqResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/home\/section-8\/faqs\/{id}": { "post": { "operationId": "admin.pages.home.section-8.faqs.update", "summary": "Update an existing FAQ in Section 8", "tags": [ "HomePage" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionEightFaqRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "FAQ updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionEightFaqResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "put": { "operationId": "admin.pages.home.section-8.faqs.update.put", "summary": "Update an existing FAQ in Section 8", "tags": [ "HomePage" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateHomePageSectionEightFaqRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "FAQ updated successfully." }, "data": { "$ref": "#\/components\/schemas\/HomePageSectionEightFaqResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "admin.pages.home.section-8.faqs.destroy", "summary": "Delete an existing FAQ in Section 8", "tags": [ "HomePage" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "FAQ deleted successfully." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/membership-applications": { "get": { "operationId": "admin.membership-applications.index", "summary": "List membership applications with optional search and filtering", "tags": [ "MembershipApplication" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "location", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `MembershipApplicationListResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MembershipApplicationListResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/membership-applications\/{id}": { "get": { "operationId": "admin.membership-applications.show", "summary": "View detailed membership application and full question\/response snapshot", "tags": [ "MembershipApplication" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`MembershipApplicationResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/MembershipApplicationResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "admin.membership-applications.destroy", "summary": "Delete a membership application", "tags": [ "MembershipApplication" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Membership application deleted successfully." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/membership-applications\/{id}\/status": { "patch": { "operationId": "admin.membership-applications.status.update", "summary": "Update application review status and admin notes", "tags": [ "MembershipApplication" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateMembershipApplicationStatusRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Membership application status updated successfully." }, "data": { "$ref": "#\/components\/schemas\/MembershipApplicationResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/supporters": { "get": { "operationId": "admin.supporters.index", "summary": "List network supporters with optional search and filtering", "tags": [ "NetworkSupporter" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "location", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `NetworkSupporterListResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NetworkSupporterListResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/supporters\/{id}": { "get": { "operationId": "admin.supporters.show", "summary": "View detailed supporter registration including full question\/response snapshot", "tags": [ "NetworkSupporter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`NetworkSupporterResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/NetworkSupporterResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "admin.supporters.destroy", "summary": "Delete a supporter registration", "tags": [ "NetworkSupporter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Supporter registration deleted successfully." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/supporters\/{id}\/status": { "patch": { "operationId": "admin.supporters.status.update", "summary": "Update supporter status and admin notes", "tags": [ "NetworkSupporter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateNetworkSupporterStatusRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Supporter status updated successfully." }, "data": { "$ref": "#\/components\/schemas\/NetworkSupporterResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/site-settings": { "get": { "operationId": "admin.site-settings.show", "description": "Retrieves current site configuration across all tabs for administration.", "summary": "Get admin site settings", "tags": [ "SiteSetting" ], "responses": { "200": { "description": "`SiteSettingResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SiteSettingResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.site-settings.update", "description": "Updates site settings across any or all tabs, handling image uploads and file replacement.", "summary": "Update admin site settings", "tags": [ "SiteSetting" ], "requestBody": { "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateSiteSettingRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Site settings updated successfully." }, "data": { "$ref": "#\/components\/schemas\/SiteSettingResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/what-we-do\/publish-status": { "patch": { "operationId": "admin.pages.what-we-do.publish-status.update", "summary": "Update publish status for the What We Do Page", "tags": [ "WhatWeDoPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "What We Do page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.what-we-do.publish-status.update.post", "summary": "Update publish status for the What We Do Page", "tags": [ "WhatWeDoPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "What We Do page publish status updated successfully." }, "data": { "type": "object", "properties": { "is_published": { "type": "boolean" } }, "required": [ "is_published" ] } }, "required": [ "message", "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pages\/what-we-do\/section-1": { "get": { "operationId": "admin.pages.what-we-do.section-1.show", "summary": "Get Section 1 (Page Header) data for admin backoffice", "tags": [ "WhatWeDoPage" ], "responses": { "200": { "description": "`WhatWeDoPageSectionOneResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionOneResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.what-we-do.section-1.update", "summary": "Update Section 1 (Page Header) in admin backoffice", "tags": [ "WhatWeDoPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateWhatWeDoPageSectionOneRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "What We Do page section 1 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionOneResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/what-we-do\/section-2": { "get": { "operationId": "admin.pages.what-we-do.section-2.show", "summary": "Get Section 2 (Our Areas of Focus) data for admin backoffice", "tags": [ "WhatWeDoPage" ], "responses": { "200": { "description": "`WhatWeDoPageSectionTwoResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionTwoResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.what-we-do.section-2.update", "summary": "Update Section 2 (Our Areas of Focus) in admin backoffice", "tags": [ "WhatWeDoPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateWhatWeDoPageSectionTwoRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "What We Do page section 2 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionTwoResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/what-we-do\/section-3": { "get": { "operationId": "admin.pages.what-we-do.section-3.show", "summary": "Get Section 3 (How We Approach Reform) data for admin backoffice", "tags": [ "WhatWeDoPage" ], "responses": { "200": { "description": "`WhatWeDoPageSectionThreeResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionThreeResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.what-we-do.section-3.update", "summary": "Update Section 3 (How We Approach Reform) in admin backoffice", "tags": [ "WhatWeDoPage" ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "$ref": "#\/components\/schemas\/UpdateWhatWeDoPageSectionThreeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "What We Do page section 3 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionThreeResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/pages\/what-we-do\/section-4": { "get": { "operationId": "admin.pages.what-we-do.section-4.show", "summary": "Get Section 4 (What BRN Does\u2014and Does Not Do) data for admin backoffice", "tags": [ "WhatWeDoPage" ], "responses": { "200": { "description": "`WhatWeDoPageSectionFourResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionFourResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "admin.pages.what-we-do.section-4.update", "summary": "Update Section 4 (What BRN Does\u2014and Does Not Do) in admin backoffice", "tags": [ "WhatWeDoPage" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateWhatWeDoPageSectionFourRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "What We Do page section 4 updated successfully." }, "data": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionFourResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/workplace-experiences": { "get": { "operationId": "admin.workplace-experiences.index", "summary": "List workplace experience submissions with optional search and filtering", "tags": [ "WorkplaceExperience" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "sector", "in": "query", "schema": { "type": "string" } }, { "name": "share_how", "in": "query", "schema": { "type": "string" } }, { "name": "is_anonymous", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `WorkplaceExperienceListResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkplaceExperienceListResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/workplace-experiences\/{id}": { "get": { "operationId": "admin.workplace-experiences.show", "summary": "View detailed workplace experience submission including full question\/response snapshot", "tags": [ "WorkplaceExperience" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`WorkplaceExperienceResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WorkplaceExperienceResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "admin.workplace-experiences.destroy", "summary": "Delete a workplace experience submission", "tags": [ "WorkplaceExperience" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Workplace experience submission deleted successfully." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/workplace-experiences\/{id}\/status": { "patch": { "operationId": "admin.workplace-experiences.status.update", "summary": "Update review status and admin notes for a submission", "tags": [ "WorkplaceExperience" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateWorkplaceExperienceStatusRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Workplace experience submission status updated successfully." }, "data": { "$ref": "#\/components\/schemas\/WorkplaceExperienceResource" } }, "required": [ "message", "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "AboutPageSectionFivePointResource": { "type": "object", "properties": { "point_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] } }, "required": [ "point_number", "title", "description", "logo_url" ], "title": "AboutPageSectionFivePointResource" }, "AboutPageSectionFiveResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "points": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AboutPageSectionFivePointResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "points", "updated_at" ], "title": "AboutPageSectionFiveResource" }, "AboutPageSectionFourResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "quote_block_highlight": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "quote_block_highlight", "image_url", "updated_at" ], "title": "AboutPageSectionFourResource" }, "AboutPageSectionOneResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "hero_description": { "type": [ "string", "null" ] }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "hero_image_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "hero_description", "button_name", "button_url", "hero_image_url", "updated_at" ], "title": "AboutPageSectionOneResource" }, "AboutPageSectionSixLeaderResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "position": { "type": "string" }, "photo_url": { "type": [ "string", "null" ] }, "sort_order": { "type": "integer" } }, "required": [ "id", "name", "position", "photo_url", "sort_order" ], "title": "AboutPageSectionSixLeaderResource" }, "AboutPageSectionSixResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "leaders": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AboutPageSectionSixLeaderResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "button_name", "button_url", "leaders", "updated_at" ], "title": "AboutPageSectionSixResource" }, "AboutPageSectionThreeResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "mission": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] } }, "required": [ "title", "description", "icon_url" ] }, "vision": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] } }, "required": [ "title", "description", "icon_url" ] }, "values": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AboutPageSectionThreeValueResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "mission", "vision", "values", "updated_at" ], "title": "AboutPageSectionThreeResource" }, "AboutPageSectionThreeValueResource": { "type": "object", "properties": { "value_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] } }, "required": [ "value_number", "title", "description", "logo_url" ], "title": "AboutPageSectionThreeValueResource" }, "AboutPageSectionTwoResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "quote_block_highlight": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "quote_block_highlight", "image_url", "updated_at" ], "title": "AboutPageSectionTwoResource" }, "AdminLoginRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "remember_me": { "type": "boolean" } }, "required": [ "email", "password" ], "title": "AdminLoginRequest" }, "AdminResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "email", "created_at", "updated_at" ], "title": "AdminResource" }, "ChangePasswordRequest": { "type": "object", "properties": { "current_password": { "type": "string" }, "password": { "type": "string", "minLength": 8 }, "password_confirmation": { "type": "string", "minLength": 8 } }, "required": [ "current_password", "password", "password_confirmation" ], "title": "ChangePasswordRequest" }, "ContactPageSectionOneResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "button_name", "button_url", "image_url", "updated_at" ], "title": "ContactPageSectionOneResource" }, "ContactPageSectionThreeOptionResource": { "type": "object", "properties": { "option_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "required": [ "option_number", "title", "description" ], "title": "ContactPageSectionThreeOptionResource" }, "ContactPageSectionThreeResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "options": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContactPageSectionThreeOptionResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "options", "updated_at" ], "title": "ContactPageSectionThreeResource" }, "ContactPageSectionTwoPointResource": { "type": "object", "properties": { "point_number": { "type": "integer" }, "title": { "type": "string" }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": {} }, "welcome_title": { "type": [ "string", "null" ] }, "welcome_description": { "type": [ "string", "null" ] } }, "required": [ "point_number", "title", "button_name", "button_url", "description", "note", "icon_url", "items", "welcome_title", "welcome_description" ], "title": "ContactPageSectionTwoPointResource" }, "ContactPageSectionTwoResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "points": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContactPageSectionTwoPointResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "points", "updated_at" ], "title": "ContactPageSectionTwoResource" }, "ContentActivityLogResource": { "type": "object", "properties": { "id": { "type": "integer" }, "page_name": { "type": "string" }, "page_key": { "type": "string" }, "section_name": { "type": [ "string", "null" ] }, "description": { "type": "string" }, "admin_name": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "formatted_date": { "type": "string" }, "relative_time": { "type": "string" } }, "required": [ "id", "page_name", "page_key", "section_name", "description", "admin_name", "created_at", "formatted_date", "relative_time" ], "title": "ContentActivityLogResource" }, "DashboardPageCardResource": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "path": { "type": "string" }, "icon": { "type": "string" }, "is_active": { "type": "boolean" }, "status_label": { "type": "string", "enum": [ "Active", "Inactive" ] }, "last_updated_at": { "type": "string" }, "last_updated_human": { "type": "string" }, "updated_by": { "type": "string" }, "edit_url": { "type": "string" } }, "required": [ "key", "title", "path", "icon", "is_active", "status_label", "last_updated_at", "last_updated_human", "updated_by", "edit_url" ], "title": "DashboardPageCardResource" }, "DashboardResource": { "type": "object", "properties": { "active_pages_count": { "type": "integer" }, "form_submissions": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0 } ] }, "total_form_submissions": { "anyOf": [ { "type": "string" }, { "type": "integer", "enum": [ 0 ] } ] }, "supporters_count": { "type": "string" }, "members_count": { "type": "string" }, "workplace_experiences_count": { "type": "string" }, "pages": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DashboardPageCardResource" } }, "recent_updates": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContentActivityLogResource" } } }, "required": [ "active_pages_count", "form_submissions", "total_form_submissions", "supporters_count", "members_count", "workplace_experiences_count", "pages", "recent_updates" ], "title": "DashboardResource" }, "HomePageSectionEightFaqResource": { "type": "object", "properties": { "id": { "type": "integer" }, "question": { "type": "string" }, "answer": { "type": "string" }, "sort_order": { "type": "integer" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "question", "answer", "sort_order", "created_at", "updated_at" ], "title": "HomePageSectionEightFaqResource" }, "HomePageSectionEightResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "faq_image_url": { "type": [ "string", "null" ] }, "faqs": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HomePageSectionEightFaqResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "faq_image_url", "faqs", "updated_at" ], "title": "HomePageSectionEightResource" }, "HomePageSectionFivePathwayResource": { "type": "object", "properties": { "step_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "icon_url": { "type": [ "string", "null" ] } }, "required": [ "step_number", "title", "description", "icon_url" ], "title": "HomePageSectionFivePathwayResource" }, "HomePageSectionFiveResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "pathways_heading": { "type": "object", "properties": { "headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] } }, "required": [ "headline", "description" ] }, "pathways": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HomePageSectionFivePathwayResource" } }, "transition_step": { "type": "object", "properties": { "connector_label": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] } }, "required": [ "connector_label", "title", "description", "icon_url" ] }, "help_block": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "checklist_items": { "type": "array", "items": {} }, "important_notice": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "title", "checklist_items", "important_notice", "subtitle", "description", "button_name", "button_url", "image_url" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "pathways_heading", "pathways", "transition_step", "help_block", "updated_at" ], "title": "HomePageSectionFiveResource" }, "HomePageSectionFourOptionResource": { "type": "object", "properties": { "option_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "icon_url": { "type": [ "string", "null" ] } }, "required": [ "option_number", "title", "description", "icon_url" ], "title": "HomePageSectionFourOptionResource" }, "HomePageSectionFourResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "options": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HomePageSectionFourOptionResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "options", "updated_at" ], "title": "HomePageSectionFourResource" }, "HomePageSectionOneResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "hero_description": { "type": [ "string", "null" ] }, "first_button_name": { "type": [ "string", "null" ] }, "first_button_url": { "type": [ "string", "null" ] }, "second_button_name": { "type": [ "string", "null" ] }, "second_button_url": { "type": [ "string", "null" ] }, "hero_image_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "hero_description", "first_button_name", "first_button_url", "second_button_name", "second_button_url", "hero_image_url", "updated_at" ], "title": "HomePageSectionOneResource" }, "HomePageSectionSevenResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "main_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "banner_image_url": { "type": [ "string", "null" ] }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "main_headline", "description", "banner_image_url", "button_name", "button_url", "updated_at" ], "title": "HomePageSectionSevenResource" }, "HomePageSectionSixActionResource": { "type": "object", "properties": { "id": { "type": "integer" }, "item_key": { "type": "string" }, "sort_order": { "type": "integer" }, "title": { "type": "string" }, "icon_url": { "type": [ "string", "null" ] }, "main_description": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "checklist_items": { "type": "array", "items": {} }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "short_note": { "type": [ "string", "null" ] }, "submissions_count": { "type": [ "integer", "null" ], "minimum": 0 }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "item_key", "sort_order", "title", "icon_url", "main_description", "note", "checklist_items", "button_name", "button_url", "short_note", "submissions_count", "updated_at" ], "title": "HomePageSectionSixActionResource" }, "HomePageSectionSixOptionResource": { "type": "object", "properties": { "option_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "icon_url": { "type": [ "string", "null" ] } }, "required": [ "option_number", "title", "description", "icon_url" ], "title": "HomePageSectionSixOptionResource" }, "HomePageSectionSixResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "action_items": { "anyOf": [ { "type": "array" }, { "type": "array", "prefixItems": [ { "type": "string", "const": "BECOME A SUPPORTER" }, { "type": "string", "const": "APPLY FOR MEMBERSHIP" }, { "type": "string", "const": "SHARE YOUR EXPERIENCE" }, { "type": "string", "const": "REQUEST SUPPORT \/ ADVOCACY" } ], "minItems": 4, "maxItems": 4 } ] }, "actions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HomePageSectionSixActionResource" } }, "options": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HomePageSectionSixOptionResource" } }, "supporters_count": { "type": "integer", "minimum": 0 }, "members_count": { "type": "integer", "minimum": 0 }, "stats": { "type": "object", "properties": { "supporters": { "type": "integer", "minimum": 0 }, "members": { "type": "integer", "minimum": 0 } }, "required": [ "supporters", "members" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "image_url", "description", "action_items", "actions", "options", "supporters_count", "members_count", "stats", "updated_at" ], "title": "HomePageSectionSixResource" }, "HomePageSectionThreeOptionResource": { "type": "object", "properties": { "option_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "option_number", "title", "description" ], "title": "HomePageSectionThreeOptionResource" }, "HomePageSectionThreeResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "options": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HomePageSectionThreeOptionResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "image_url", "options", "updated_at" ], "title": "HomePageSectionThreeResource" }, "HomePageSectionTwoResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "image_url", "description", "button_name", "button_url", "updated_at" ], "title": "HomePageSectionTwoResource" }, "MembershipApplicationListResource": { "type": "object", "properties": { "id": { "type": "integer" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "location": { "type": "string" }, "employment_status": { "type": [ "string", "null" ] }, "occupation": { "type": [ "string", "null" ] }, "organization": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "has_conflict": { "type": "boolean" }, "has_workplace_matter": { "type": "boolean" }, "submitted_at": { "type": "string" }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "full_name", "email", "phone", "location", "employment_status", "occupation", "organization", "status", "has_conflict", "has_workplace_matter", "submitted_at", "created_at" ], "title": "MembershipApplicationListResource" }, "MembershipApplicationResource": { "type": "object", "properties": { "id": { "type": "integer" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "location": { "type": "string" }, "employment_status": { "type": [ "string", "null" ] }, "occupation": { "type": [ "string", "null" ] }, "organization": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "has_conflict": { "type": "boolean" }, "has_workplace_matter": { "type": "boolean" }, "form_version": { "type": "string" }, "form_snapshot": { "type": "array", "items": {} }, "admin_notes": { "type": [ "string", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "user_agent": { "type": [ "string", "null" ] }, "submitted_at": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "full_name", "email", "phone", "location", "employment_status", "occupation", "organization", "status", "has_conflict", "has_workplace_matter", "form_version", "form_snapshot", "admin_notes", "ip_address", "user_agent", "submitted_at", "created_at", "updated_at" ], "title": "MembershipApplicationResource" }, "NetworkSupporterListResource": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": [ "string", "null" ] }, "location": { "type": "string" }, "contact_permission": { "type": "boolean" }, "receive_updates": { "type": "boolean" }, "status": { "type": "string" }, "submitted_at": { "type": "string" }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "first_name", "last_name", "full_name", "email", "phone", "location", "contact_permission", "receive_updates", "status", "submitted_at", "created_at" ], "title": "NetworkSupporterListResource" }, "NetworkSupporterResource": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": [ "string", "null" ] }, "location": { "type": "string" }, "support_reason": { "type": [ "string", "null" ] }, "contact_permission": { "type": "boolean" }, "receive_updates": { "type": "boolean" }, "status": { "type": "string" }, "form_version": { "type": "string" }, "form_snapshot": { "type": "array", "items": {} }, "admin_notes": { "type": [ "string", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "user_agent": { "type": [ "string", "null" ] }, "submitted_at": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "first_name", "last_name", "full_name", "email", "phone", "location", "support_reason", "contact_permission", "receive_updates", "status", "form_version", "form_snapshot", "admin_notes", "ip_address", "user_agent", "submitted_at", "created_at", "updated_at" ], "title": "NetworkSupporterResource" }, "SiteSettingResource": { "type": "object", "properties": { "favicon": { "type": "object", "properties": { "logo_url": { "type": [ "string", "null" ] } }, "required": [ "logo_url" ] }, "header": { "type": "object", "properties": { "logo_url": { "type": [ "string", "null" ] } }, "required": [ "logo_url" ] }, "footer": { "type": "object", "properties": { "logo_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "copyright": { "type": [ "string", "null" ] } }, "required": [ "logo_url", "description", "copyright" ] }, "social_media_links": { "type": "object", "properties": { "facebook_url": { "type": [ "string", "null" ] }, "twitter_url": { "type": [ "string", "null" ] }, "instagram_url": { "type": [ "string", "null" ] }, "linkedin_url": { "type": [ "string", "null" ] } }, "required": [ "facebook_url", "twitter_url", "instagram_url", "linkedin_url" ] }, "contact_info": { "type": "object", "properties": { "address_line_1": { "type": [ "string", "null" ] }, "address_line_2": { "type": [ "string", "null" ] }, "landmark": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "zip_code": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone_no": { "type": [ "string", "null" ] } }, "required": [ "address_line_1", "address_line_2", "landmark", "city", "state", "zip_code", "email", "phone_no" ] }, "call_to_action_banner": { "type": "object", "properties": { "main_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "bg_image_url": { "type": [ "string", "null" ] }, "first_button_name": { "type": [ "string", "null" ] }, "first_button_url": { "type": [ "string", "null" ] }, "second_button_name": { "type": [ "string", "null" ] }, "second_button_url": { "type": [ "string", "null" ] } }, "required": [ "main_headline", "description", "bg_image_url", "first_button_name", "first_button_url", "second_button_name", "second_button_url" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "favicon", "header", "footer", "social_media_links", "contact_info", "call_to_action_banner", "updated_at" ], "title": "SiteSettingResource" }, "StoreAboutPageSectionSixLeaderRequest": { "type": "object", "properties": { "position": { "type": "string", "maxLength": 255 }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "photo": { "type": "string", "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "sort_order": { "type": "integer" } }, "required": [ "position", "photo" ], "title": "StoreAboutPageSectionSixLeaderRequest" }, "StoreHomePageSectionEightFaqRequest": { "type": "object", "properties": { "question": { "type": "string", "maxLength": 255 }, "answer": { "type": "string" }, "sort_order": { "type": "integer" } }, "required": [ "question", "answer" ], "title": "StoreHomePageSectionEightFaqRequest" }, "UpdateAboutPageSectionFiveRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "points": { "type": "array", "items": { "type": "object", "properties": { "point_number": { "type": "integer", "minimum": 1, "maximum": 6 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "logo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "point_number", "title" ] } } }, "required": [ "first_headline", "second_headline", "description" ], "title": "UpdateAboutPageSectionFiveRequest" }, "UpdateAboutPageSectionFourRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "quote_block_highlight": { "type": "string" }, "image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "first_headline", "second_headline", "description", "quote_block_highlight" ], "title": "UpdateAboutPageSectionFourRequest" }, "UpdateAboutPageSectionOneRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "hero_description": { "type": "string" }, "button_name": { "type": "string", "maxLength": 255 }, "button_url": { "type": "string", "maxLength": 255 }, "hero_image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "first_headline", "second_headline", "hero_description", "button_name", "button_url" ], "title": "UpdateAboutPageSectionOneRequest" }, "UpdateAboutPageSectionSixLeaderRequest": { "type": "object", "properties": { "position": { "type": "string", "maxLength": 255 }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "photo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "sort_order": { "type": "integer" } }, "required": [ "position" ], "title": "UpdateAboutPageSectionSixLeaderRequest" }, "UpdateAboutPageSectionSixRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "button_name": { "type": "string", "maxLength": 255 }, "button_url": { "type": "string", "maxLength": 255 } }, "required": [ "first_headline", "second_headline", "description", "button_name", "button_url" ], "title": "UpdateAboutPageSectionSixRequest" }, "UpdateAboutPageSectionThreeRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "mission_title": { "type": "string", "maxLength": 255 }, "mission_description": { "type": "string" }, "mission_icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "vision_title": { "type": "string", "maxLength": 255 }, "vision_description": { "type": "string" }, "vision_icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "values": { "type": "array", "items": { "type": "object", "properties": { "value_number": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "logo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "value_number", "title" ] } } }, "required": [ "first_headline", "second_headline", "description", "mission_title", "mission_description", "vision_title", "vision_description" ], "title": "UpdateAboutPageSectionThreeRequest" }, "UpdateAboutPageSectionTwoRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "quote_block_highlight": { "type": "string" }, "image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "first_headline", "second_headline", "description", "quote_block_highlight" ], "title": "UpdateAboutPageSectionTwoRequest" }, "UpdateContactPageSectionOneRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "button_name": { "type": "string", "maxLength": 255 }, "button_url": { "type": "string", "maxLength": 255 }, "image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "first_headline", "second_headline", "description", "button_name", "button_url" ], "title": "UpdateContactPageSectionOneRequest" }, "UpdateContactPageSectionThreeRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "option_number": { "type": "integer", "minimum": 1, "maximum": 3 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] } }, "required": [ "option_number", "title" ] }, "minItems": 1 } }, "required": [ "first_headline", "second_headline", "description", "options" ], "title": "UpdateContactPageSectionThreeRequest" }, "UpdateContactPageSectionTwoRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "points": { "type": "array", "items": { "type": "object", "properties": { "point_number": { "type": "integer", "minimum": 1, "maximum": 4 }, "title": { "type": "string", "maxLength": 255 }, "button_name": { "type": [ "string", "null" ], "maxLength": 255 }, "button_url": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ], "maxLength": 255 }, "icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "items": { "type": [ "array", "null" ], "items": { "type": "string" } }, "welcome_title": { "type": [ "string", "null" ], "maxLength": 255 }, "welcome_description": { "type": [ "string", "null" ] } }, "required": [ "point_number", "title" ] }, "minItems": 1 } }, "required": [ "first_headline", "second_headline", "description", "points" ], "title": "UpdateContactPageSectionTwoRequest" }, "UpdateHomePageSectionEightFaqRequest": { "type": "object", "properties": { "question": { "type": "string", "maxLength": 255 }, "answer": { "type": "string" }, "sort_order": { "type": "integer" } }, "title": "UpdateHomePageSectionEightFaqRequest" }, "UpdateHomePageSectionEightRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "faq_image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "faqs": { "type": "array", "items": { "type": "object", "properties": { "question": { "type": "string", "maxLength": 255 }, "answer": { "type": "string" }, "sort_order": { "type": "integer" } }, "required": [ "question", "answer" ] } } }, "required": [ "first_headline", "second_headline", "description" ], "title": "UpdateHomePageSectionEightRequest" }, "UpdateHomePageSectionFiveRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "pathways_headline": { "type": "string", "maxLength": 255 }, "pathways_description": { "type": "string" }, "pathways": { "type": "array", "items": { "type": "object", "properties": { "step_number": { "type": "integer", "minimum": 1, "maximum": 4 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "step_number", "title", "description" ] } }, "transition_connector_label": { "type": "string", "maxLength": 255 }, "transition_title": { "type": "string", "maxLength": 255 }, "transition_description": { "type": "string" }, "transition_icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "help_title": { "type": "string", "maxLength": 255 }, "help_checklist_items": { "type": "array", "items": { "type": "string" } }, "help_important_notice": { "type": "string" }, "help_subtitle": { "type": "string", "maxLength": 255 }, "help_description": { "type": "string" }, "help_button_name": { "type": "string", "maxLength": 255 }, "help_button_url": { "type": "string", "maxLength": 255 }, "help_image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "first_headline", "second_headline", "description", "pathways_headline", "pathways_description", "transition_connector_label", "transition_title", "transition_description", "help_title", "help_important_notice", "help_subtitle", "help_description", "help_button_name", "help_button_url" ], "title": "UpdateHomePageSectionFiveRequest" }, "UpdateHomePageSectionFourRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "option_number": { "type": "integer", "minimum": 1, "maximum": 4 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "option_number", "title", "description" ] } } }, "required": [ "first_headline", "second_headline", "description" ], "title": "UpdateHomePageSectionFourRequest" }, "UpdateHomePageSectionOneRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "hero_description": { "type": "string" }, "first_button_name": { "type": "string", "maxLength": 255 }, "first_button_url": { "type": "string", "maxLength": 255 }, "second_button_name": { "type": "string", "maxLength": 255 }, "second_button_url": { "type": "string", "maxLength": 255 }, "hero_image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "first_headline", "second_headline", "hero_description", "first_button_name", "first_button_url", "second_button_name", "second_button_url" ], "title": "UpdateHomePageSectionOneRequest" }, "UpdateHomePageSectionSevenRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "main_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "banner_image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "button_name": { "type": "string", "maxLength": 255 }, "button_url": { "type": "string", "maxLength": 255 } }, "required": [ "main_headline", "description", "button_name", "button_url" ], "title": "UpdateHomePageSectionSevenRequest" }, "UpdateHomePageSectionSixActionRequest": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255 }, "icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "main_description": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "checklist_items": { "type": "array", "items": { "type": "string", "maxLength": 500 }, "minItems": 1 }, "button_name": { "type": "string", "maxLength": 255 }, "button_url": { "type": "string", "maxLength": 255 }, "short_note": { "type": [ "string", "null" ], "maxLength": 255 }, "sort_order": { "type": "integer", "minimum": 1 } }, "required": [ "title", "main_description", "checklist_items", "button_name", "button_url" ], "title": "UpdateHomePageSectionSixActionRequest" }, "UpdateHomePageSectionSixRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "description": { "type": "string" }, "action_items": { "type": "array", "items": { "type": "string" } }, "options": { "type": "array", "items": { "type": "object", "properties": { "option_number": { "type": "integer", "minimum": 1, "maximum": 4 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "icon": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "option_number", "title", "description" ] } } }, "required": [ "first_headline", "second_headline", "description" ], "title": "UpdateHomePageSectionSixRequest" }, "UpdateHomePageSectionThreeRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "options": { "type": "array", "items": { "type": "object", "properties": { "option_number": { "type": "integer", "minimum": 1, "maximum": 6 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string" } }, "required": [ "option_number", "title", "description" ] } } }, "required": [ "first_headline", "second_headline", "description" ], "title": "UpdateHomePageSectionThreeRequest" }, "UpdateHomePageSectionTwoRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "description": { "type": "string" }, "button_name": { "type": "string", "maxLength": 255 }, "button_url": { "type": "string", "maxLength": 255 } }, "required": [ "first_headline", "second_headline", "description", "button_name", "button_url" ], "title": "UpdateHomePageSectionTwoRequest" }, "UpdateMembershipApplicationStatusRequest": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "under_review", "approved", "declined" ] }, "admin_notes": { "type": [ "string", "null" ], "maxLength": 5000 } }, "required": [ "status" ], "title": "UpdateMembershipApplicationStatusRequest" }, "UpdateNetworkSupporterStatusRequest": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "confirmed", "active", "archived", "unsubscribed" ] }, "admin_notes": { "type": [ "string", "null" ], "maxLength": 5000 } }, "required": [ "status" ], "title": "UpdateNetworkSupporterStatusRequest" }, "UpdateSiteSettingRequest": { "type": "object", "properties": { "favicon_logo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Favicon" }, "header_logo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Header" }, "footer_logo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Footer" }, "footer_description": { "type": [ "string", "null" ] }, "footer_copyright": { "type": [ "string", "null" ], "maxLength": 255 }, "facebook_url": { "type": [ "string", "null" ], "format": "uri", "description": "Social Media Links", "maxLength": 255 }, "twitter_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 255 }, "instagram_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 255 }, "linkedin_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 255 }, "address_line_1": { "type": [ "string", "null" ], "description": "Contact Info", "maxLength": 255 }, "address_line_2": { "type": [ "string", "null" ], "maxLength": 255 }, "landmark": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "state": { "type": [ "string", "null" ], "maxLength": 255 }, "zip_code": { "type": [ "string", "null" ], "maxLength": 50 }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "phone_no": { "type": [ "string", "null" ], "maxLength": 50 }, "cta_main_headline": { "type": [ "string", "null" ], "description": "Call To Action Banner", "maxLength": 255 }, "cta_description": { "type": [ "string", "null" ] }, "cta_bg_image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." }, "cta_first_button_name": { "type": [ "string", "null" ], "maxLength": 100 }, "cta_first_button_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 255 }, "cta_second_button_name": { "type": [ "string", "null" ], "maxLength": 100 }, "cta_second_button_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 255 } }, "title": "UpdateSiteSettingRequest" }, "UpdateWhatWeDoPageSectionFourRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "what_we_do_headline": { "type": "string", "maxLength": 255 }, "what_we_do_items": { "type": [ "array", "null" ], "items": { "type": "string" } }, "what_we_do_not_do_headline": { "type": "string", "maxLength": 255 }, "what_we_do_not_do_items": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "first_headline", "second_headline", "what_we_do_headline", "what_we_do_not_do_headline" ], "title": "UpdateWhatWeDoPageSectionFourRequest" }, "UpdateWhatWeDoPageSectionOneRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "hero_description": { "type": "string" }, "button_name": { "type": "string", "maxLength": 255 }, "button_url": { "type": "string", "maxLength": 255 }, "hero_image": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "first_headline", "second_headline", "hero_description", "button_name", "button_url" ], "title": "UpdateWhatWeDoPageSectionOneRequest" }, "UpdateWhatWeDoPageSectionThreeRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "points": { "type": "array", "items": { "type": "object", "properties": { "point_number": { "type": "integer", "minimum": 1, "maximum": 6 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "logo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "point_number", "title" ] }, "minItems": 1 } }, "required": [ "first_headline", "second_headline", "description", "points" ], "title": "UpdateWhatWeDoPageSectionThreeRequest" }, "UpdateWhatWeDoPageSectionTwoRequest": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": "string", "maxLength": 255 }, "second_headline": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "points": { "type": "array", "items": { "type": "object", "properties": { "point_number": { "type": "integer", "minimum": 1, "maximum": 4 }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "logo": { "type": [ "string", "null" ], "format": "binary", "contentMediaType": "application\/octet-stream", "description": "Maximum file size: 5120 kilobytes." } }, "required": [ "point_number", "title" ] }, "minItems": 1 } }, "required": [ "first_headline", "second_headline", "description", "points" ], "title": "UpdateWhatWeDoPageSectionTwoRequest" }, "UpdateWorkplaceExperienceStatusRequest": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "under_review", "reviewed", "archived" ] }, "admin_notes": { "type": [ "string", "null" ], "maxLength": 5000 } }, "required": [ "status" ], "title": "UpdateWorkplaceExperienceStatusRequest" }, "WhatWeDoPageSectionFourResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "what_we_do": { "type": "object", "properties": { "headline": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": {} } }, "required": [ "headline", "items" ] }, "what_we_do_not_do": { "type": "object", "properties": { "headline": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": {} } }, "required": [ "headline", "items" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "what_we_do", "what_we_do_not_do", "updated_at" ], "title": "WhatWeDoPageSectionFourResource" }, "WhatWeDoPageSectionOneResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "hero_description": { "type": [ "string", "null" ] }, "button_name": { "type": [ "string", "null" ] }, "button_url": { "type": [ "string", "null" ] }, "hero_image_url": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "hero_description", "button_name", "button_url", "hero_image_url", "updated_at" ], "title": "WhatWeDoPageSectionOneResource" }, "WhatWeDoPageSectionThreePointResource": { "type": "object", "properties": { "point_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] } }, "required": [ "point_number", "title", "description", "logo_url" ], "title": "WhatWeDoPageSectionThreePointResource" }, "WhatWeDoPageSectionThreeResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "points": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionThreePointResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "points", "updated_at" ], "title": "WhatWeDoPageSectionThreeResource" }, "WhatWeDoPageSectionTwoPointResource": { "type": "object", "properties": { "point_number": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] } }, "required": [ "point_number", "title", "description", "logo_url" ], "title": "WhatWeDoPageSectionTwoPointResource" }, "WhatWeDoPageSectionTwoResource": { "type": "object", "properties": { "is_published": { "type": "boolean" }, "first_headline": { "type": [ "string", "null" ] }, "second_headline": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "points": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WhatWeDoPageSectionTwoPointResource" } }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "is_published", "first_headline", "second_headline", "description", "points", "updated_at" ], "title": "WhatWeDoPageSectionTwoResource" }, "WorkplaceExperienceListResource": { "type": "object", "properties": { "id": { "type": "integer" }, "share_how": { "type": "string" }, "is_anonymous": { "type": "boolean" }, "full_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "employment_sector": { "type": "string" }, "employer": { "type": [ "string", "null" ] }, "job_level": { "type": "string" }, "primary_concern": { "type": "string" }, "status": { "type": "string" }, "has_attachments": { "type": "boolean" }, "submitted_at": { "type": "string" }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "share_how", "is_anonymous", "full_name", "email", "phone", "employment_sector", "employer", "job_level", "primary_concern", "status", "has_attachments", "submitted_at", "created_at" ], "title": "WorkplaceExperienceListResource" }, "WorkplaceExperienceResource": { "type": "object", "properties": { "id": { "type": "integer" }, "share_how": { "type": "string" }, "is_anonymous": { "type": "boolean" }, "full_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "employment_sector": { "type": "string" }, "employer": { "type": [ "string", "null" ] }, "job_level": { "type": "string" }, "primary_concern": { "type": "string" }, "status": { "type": "string" }, "form_version": { "type": "string" }, "form_snapshot": { "type": "array", "items": {} }, "attachments": { "type": "array", "items": {} }, "admin_notes": { "type": [ "string", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "user_agent": { "type": [ "string", "null" ] }, "submitted_at": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "share_how", "is_anonymous", "full_name", "email", "phone", "employment_sector", "employer", "job_level", "primary_concern", "status", "form_version", "form_snapshot", "attachments", "admin_notes", "ip_address", "user_agent", "submitted_at", "created_at", "updated_at" ], "title": "WorkplaceExperienceResource" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }