Skip to content

Commit

Permalink
[512] Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
avinhurry committed Dec 18, 2024
1 parent 2849ba1 commit e1a4fb4
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,12 @@
<ul class="govuk-list govuk-list--bullet">
<li><code>confidential</code> (boolean, required)</li>
</ul>

<p class="govuk-heading-s">Add inactive to the ApplicationAttribute</p>

<p class="govuk-body">
The following update has been made to the <%= govuk_link_to 'application', '#applicationattributes-object' %> object:

<ul class="govuk-list govuk-list--bullet">
<li><code>inactive</code> (boolean, required)</li>
</ul>
9 changes: 9 additions & 0 deletions app/views/api_docs/vendor_api_docs/reference/draft.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,15 @@
<li><code>confidential</code> (boolean, required)</li>
</ul>

<p class="govuk-heading-s">Add inactive to the ApplicationAttribute</p>

<p class="govuk-body">
The following update has been made to the <%= govuk_link_to 'application', '#applicationattributes-object' %> object:

<ul class="govuk-list govuk-list--bullet">
<li><code>inactive</code> (boolean, required)</li>
</ul>

<hr class="govuk-section-break govuk-section-break--visible govuk-!-margin-top-6 govuk-!-margin-bottom-6">

<h2 class="govuk-heading-l" id="developing">Developing on the API</h2>
Expand Down
6 changes: 6 additions & 0 deletions config/vendor_api/draft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ servers:
url: https://www.apply-for-teacher-training.service.gov.uk/api/v1.5
components:
schemas:
ApplicationAttributes:
properties:
inactive:
type: boolean
description: Indicates whether the application is inactive, based on time-sensitive criteria. If true, the application is considered inactive; otherwise, it remains active.
example: "2024-07-10T13:00:00+01:00"
Reference:
type: object
properties:
Expand Down

0 comments on commit e1a4fb4

Please sign in to comment.