Remove forms-api from sequence diagrams

The forms-api app is no longer used in any part of our system, its data
and responsibilities have been moved to the forms-admin app, and
forms-runner retrieves form definitions from forms-admin.

The sequence diagrams in this repo need to be updated to reflect that,
this commit does so.

This does mean that there is less detail in some sequence diagrams,
however this is accurate as to our external API surface; forms-admin
exposes fewer public API endpoints than forms-api did.

Author: lfdebrux

diagrams/sequence-diagrams/changing-a-form.md

@@ -8,48 +8,35 @@ sequenceDiagram
   participant browser as Web Browser
   participant admin as forms-admin
   link admin: GitHub repo @ https://github.com/alphagov/forms-admin   
-  participant api as forms-api
-  link api: GitHub repo @ https://github.com/alphagov/forms-api 
 
   note right of user: Form has already been made live
 
   user->>browser: visit live form page
   browser->>admin: GET /forms/{form id}/live
-  admin->>api: GET /api/v1/forms/{form id}
-  admin->>api: GET /api/v1/forms/{form id}/live
   browser-->>user: show live form page
   
   user->>browser: click "Create a draft to edit" button
   browser->>admin: GET /forms/{form id}
-  admin->>api: GET /forms/{form id}
-  admin->>api: GET /forms/{form id}/pages
   browser-->>user: show draft form page with task list
   
-  note over user,api: User edits the draft form (See Creating form)<br>until they are ready to make their changes live
+  note over user,admin: User edits the draft form (See Creating form)<br>until they are ready to make their changes live
 
   user->>browser: click "Make your changes live" task
   browser->>admin: GET /forms/{form id}/make-live
-  admin->>api: GET /api/v1/forms/{form id}
   browser-->>user: show "Make your changes live" page
   alt form creator decides not to make form live
     user->>browser: click "No" and submits page
     browser->>admin: POST /forms/{form id}/make-live<br>payload: {forms_make_live_form"=><br>{"confirm_make_live"=>"not_made_live"},<br>"form_id"=>"{form id"}}
-    admin->>api: GET /api/v1/forms/{form id}
     admin-->>browser: REDIRECT 302
     browser->>admin: GET /forms/{form id}
-    admin->>api: GET /forms/{form id}
-    admin->>api: GET /forms/{form id}/pages
     browser-->>user: show draft form page with task list
   else form creator decides to make form live
     user->>browser: click "Yes" and submits page
     browser->>admin: POST /forms/{form id}/make-live<br>payload: {forms_make_live_form"=><br>{"confirm_make_live"=>"made_live"},<br>"form_id"=>"{form id"}}
-    admin->>api: POST /api/v1/forms/{form id}/make-live<br>payload: {includes all form attributes and values}<br>Controller Action doesn't use any
-    note over admin,api: Creates a new record in published_forms table,<br>with a copy of the form and all its pages<br>
+    note over admin,admin: Creates a new record in published forms table,<br>with a copy of the form and all its pages<br>
     browser-->>user: show "Your form is live" confirmation page
     user->>browser: click "Continue to form details" link
     browser->>admin: GET /forms/{form id}/live
-    admin->>api: GET /api/v1/forms/{form id}
-    admin->>api: GET /api/v1/forms/{form id}/live
     browser-->>user: show live form page
   end
 ```

diagrams/sequence-diagrams/creating-a-form.md

@@ -7,8 +7,6 @@ sequenceDiagram
   participant browser as Web Browser
   participant admin as forms-admin
   link admin: GitHub repo @ https://github.com/alphagov/forms-admin
-  participant api as forms-api
-  link api: GitHub repo @ https://github.com/alphagov/forms-api
 
   note right of user: user has already logged in
 
@@ -17,13 +15,9 @@ sequenceDiagram
   browser-->>user: show "What is the name of your form?" page
   user->>browser: Give the form a name<br />click "Save and continue" button
   browser->>admin: POST /forms/new<br />payload: forms_change_name_form%5Bname%5D={form name}
-  admin->>api: POST /forms<br />{"name":"{form name}",<br />"submission_email":"",<br />"organisation_id":{user organisation id}}
-  api->>api: Create form
-  api-->>admin: {"id":{form id}}
+  admin->>admin: Create form
   admin-->>browser: 302
   browser->>admin: GET /forms/{form id}
-  admin->>api: GET /forms/{form id}
-  admin->>api: GET /forms/{form id}/pages
   browser-->>user: show "Create a form" page
 ```
 
@@ -36,15 +30,11 @@ sequenceDiagram
   participant browser as Web Browser
   participant admin as forms-admin
   link admin: GitHub repo @ https://github.com/alphagov/forms-admin
-  participant api as forms-api
-  link api: GitHub repo @ https://github.com/alphagov/forms-api
 
   note right of user: On the "Create a form" page
 
   user->>browser: click "Add and edit your questions" link
   browser->>admin: GET /forms/1/pages/new/type-of-answer
-  admin->>api: GET /forms/{form id}
-  admin->>api: GET /forms/{form id}/pages
 
   browser-->>user: show "What kind of answer do you need to this question?" page
 
@@ -59,9 +49,7 @@ sequenceDiagram
   user->>browser: Provide Question text, Hint text (optional), Question settings
   user->>browser: Click "Save and add next question" OR "Save question" button
   browser->>admin: POST /forms/{form id}/pages/new/question
-  admin->>api: POST /forms/{form id}/pages<br />{"question_text":,<br />"hint_text":,<br />"answer_type":,<br />"is_optional":,<br />"answer_settings":{"input_type":}
-  api->>api: create page
-  api-->>admin: 201
+  admin->>admin: create page
 
   alt "Save and add next question" clicked
     admin-->>browser: 302
@@ -83,25 +71,18 @@ sequenceDiagram
   participant browser as Web Browser
   participant admin as forms-admin
   link admin: GitHub repo @ https://github.com/alphagov/forms-admin
-  participant api as forms-api
-  link api: GitHub repo @ https://github.com/alphagov/forms-api
 
   note right of user: form already created
 
   user->>browser: click "Add a declaration for people to agree to" link
   browser->>admin: GET /forms/{form id}/declaration
 
-  admin->>api: GET /forms/{form id}
   browser-->>user: show "Add a declaration" page
   user->>browser: Provide declaration<br />click "Save and continue" button
   browser->>admin: POST /forms/{form id}/declaration
-  admin->>api: GET /forms/{form id}
-  admin->>api: PUT /forms/{form id}
-  api->>api: Update form
+  admin->>admin: Update form
   admin-->>browser: 302
   browser->>admin: GET /forms/{form id}
-  admin->>api: GET /forms/{form id}
-  admin->>api: GET /forms/{form id}/pages
   browser-->>user: show "Create a form" page
 ```
 
@@ -120,8 +101,6 @@ sequenceDiagram
   participant browser as Web Browser
   participant admin as forms-admin
   link admin: GitHub repo @ https://github.com/alphagov/forms-admin
-  participant api as forms-api
-  link api: GitHub repo @ https://github.com/alphagov/forms-api
   participant notify as GOV.UK Notify
   participant inbox as shared email inbox
   actor processor as form processor
@@ -130,7 +109,6 @@ sequenceDiagram
 
   user->>browser: click "Set the email address for completed forms" link
   browser->>admin: GET /forms/{form id}/submission-email
-  admin->>api: GET /forms/{form id}
   browser-->>user: show "Set the email address for completed forms" page
   user->>browser: Provide email address<br />click "Save and continue" button
   browser->>admin: POST /forms/{form id}/submission-email
@@ -139,36 +117,30 @@ sequenceDiagram
   notify->>inbox: Send email
   admin-->>browser: 302
   browser->>admin: GET /forms/{form id}/email-code-sent
-  admin->>api: GET /forms/{form id}
   browser-->>user: show "Confirmation code sent" page
 
   inbox--)processor: read email
   processor--)user: provide confirmation_code
 
   user->>browser: click "Enter the email address confirmation code" link
   browser->>admin: GET /forms/{form id}/confirm-submission-email
-  admin->>api: GET /forms/{form id}
   browser-->>user: show "Enter the confirmation code" page 
 
   user->>browser: enter code, click "Save and continue" button
   browser->>admin: POST /forms/{form id}/confirm-submission-email
-  admin->>api: GET /forms/{form id}
   admin->>admin: check code
 
   opt wrong code entered
     admin-->>browser: 200
     browser-->>user: show "Enter the confirmation code" page with error
     user->>browser: enter code, click "Save and continue" button
     browser->>admin: POST /forms/{form id}/confirm-submission-email
-    admin->>api: GET /forms/{form id}
     admin->>admin: check code
   end
 
-  admin->>api: PUT /forms/{form id}
-  api->>api: update form 
+  admin->>admin: update form
   admin-->>browser: 302
   browser->>admin: GET /forms/{form id}/submission-email-confirmed
-  admin->>api: GET /forms/{form id}
   browser-->>user: show "Email address confirmed" page
 ```
 
@@ -183,20 +155,15 @@ sequenceDiagram
   link admin: GitHub repo @ https://github.com/alphagov/forms-admin  
   participant runner as forms-runner
   link runner: GitHub repo @ https://github.com/alphagov/forms-runner  
-  participant api as forms-api
-  link api: GitHub repo @ https://github.com/alphagov/forms-api  
 
   note right of user: At least one question has been added
 
   admin-->>user: show "Create a form" page
   user->>browser: Click "Preview this form in a new tab" link
   browser->>runner: GET /preview-form/{form id}/{form slug}
-  runner->>api: GET /forms/{form id}
   runner->>runner: determine start page  
   runner-->>browser: 302
   browser->>runner: GET /forms/{form id}/{form slug}/{start page id}
-  runner->>api: GET /forms/{form id}
-  runner->>api: GET /forms/{form id}/pages
   runner-->>browser: render form start page
   browser-->>user: show form preview in new tab
 ```

diagrams/sequence-diagrams/filling-in-a-form.md

@@ -6,7 +6,7 @@ sequenceDiagram
   participant browser as Web Browser
   participant govuk as GOV.UK website
   participant runner as forms-runner
-  participant api as forms-api
+  participant admin as forms-admin
   participant notify as GOV.UK Notify
   participant inbox as shared email inbox
   actor processor as Form processor
@@ -18,34 +18,34 @@ sequenceDiagram
   user->>browser: Click link to form
   browser->>runner: GET /form/{form id}/{form slug}
   note over browser,runner: Start 
-  runner->>api: GET /api/v1/forms/{form id}/live
+  runner->>admin: GET /api/v2/forms/{form id}/live
   runner->>runner: determine start page  
   runner-->>browser: 302
   browser->>runner: GET /form/{form id}/{form slug}/{start page id}
-  runner->>api: GET /api/v1/forms/{form id}/live
+  runner->>admin: GET /api/v2/forms/{form id}/live
   browser-->>user: show form
 
   loop for each form question
     user->>browser: Provide answer, click "Continue"
     browser->>runner: POST /form/{form id}/{form slug}/{page id}
-    runner->>api: GET /api/v1/forms/{form id}/live
+    runner->>admin: GET /api/v2/forms/{form id}/live
     runner->>runner: Save user session
     runner-->>browser: 302
     browser->>runner: GET /form/{form id}/{form slug}/{next page id}
-    runner->>api: GET /api/v1/forms/{form id}/live
+    runner->>admin: GET /api/v2/forms/{form id}/live
     browser-->>user: Show next question    
   end
 
   browser->>runner: GET /form/{form id}/{form slug}/check_your_answers
   browser-->>user: Show check your answers page
   user->>browser: Click "Submit"
   browser->>runner: POST /form/{form id}/{form slug}/submit-answers
-  runner->>api: GET /api/v1/forms/{form id}/live
+  runner->>admin: GET /api/v2/forms/{form id}/live
   runner->>notify: client.send_email()
   runner->>runner: Delete user session
   runner-->>browser: 302
   browser->>runner: GET /form/{form id}/{form slug}/submitted
-  runner->>api: GET /api/v1/forms/{form id}/live
+  runner->>admin: GET /api/v2/forms/{form id}/live
   browser-->>user: Show confirmation page
   notify->>inbox: Send email
   inbox->>processor: Read email
@@ -60,12 +60,12 @@ sequenceDiagram
   actor user as Form filler
   participant browser as Web Browser
   participant runner as forms-runner
-  participant api as forms-api
+  participant admin as forms-admin
   participant notify as GOV.UK Notify
 
   user->>browser: Click link to form
   browser->>runner: GET /form/{form id}/{form slug}
-  runner->>api: GET /api/v1/forms/{form id}/live
+  runner->>admin: GET /api/v2/forms/{form id}/live
   runner-->browser: REDIRECT 302 (includes first page id)
   browser->>runner: GET /form/{form id}/{forms slug}/{page id}
   Note over browser,runner: A new session has started 

diagrams/sequence-diagrams/publishing-a-form.md

@@ -7,22 +7,16 @@ sequenceDiagram
   participant browser as Web Browser
   participant admin as forms-admin
   link admin: GitHub repo @ https://github.com/alphagov/forms-admin   
-  participant api as forms-api
-  link api: GitHub repo @ https://github.com/alphagov/forms-api  
 
   note right of user: All tasks except "Make your form live" have been completed
 
   admin-->>user: show "Create a form" page
   user->>browser: Click "Make your form live" link
   browser->>admin: GET /forms/{form id}/make-live
-  admin->>api: GET /api/v1/forms/{form id}
   browser-->>user: show "Make your form live" page
 
   user->>browser: Confirm making form live<br />click "Save and continue" button
   browser->>admin: POST /forms/{form id}/make-live
-  admin->>api: GET /api/v1/forms/{form id}
-  admin->>api: GET /api/v1/forms/{form id}/pages
-  admin->>api: POST /api/v1/forms/{form id}/make-live<br>payload: {includes all form attributes and values}<br>Controller Action doesn't use any
   browser-->>user: show "Your form is live" page
   user->>user: Copy URL for the form