Skip to content

Commit 1a10633

Browse files
IuhegiIuhegi
authored
Merge pull request #7 from LandRegistry/aanr
Add documentation for new services
2 parents 7d3b39a + 94b7f93 commit 1a10633

File tree

125 files changed

+23945
-902
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+23945
-902
lines changed

‎.DS_Store‎

6 KB
Binary file not shown.

‎.vscode/settings.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
{
2+
"git.autorefresh": true
23
}

‎_site/a-guide-to-soap-and-rest-api-types/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ <h1 class="govuk-heading-xl">A guide to SOAP and REST API types</h1>
9999
<p class="govuk-body govuk-!-font-weight-regular">Learn more about REST and SOAP and how to integrate them below. For a list of APIs, visit <a class="govuk-link" href="/find-a-service-api">Find an API</a>. Here, you’ll find a SOAP or REST tag next to each title. This shows which of the two API types you’ll need to integrate an HMLR service.</p>
100100
<h2 class="govuk-heading-m">How to use our APIs to build services</h2>
101101
<p class="govuk-body">We're working on this section. It will provide an overview of how to use Business Gateway APIs to build HMLR services.</p>
102-
<p class="govuk-body">Read our <a href="https://landregistry.github.io/bgtechdoc/get_started/developer_guide" class="govuk-link">developer guide to SOAP</a> to integrate with legacy services using SOAP/XML. You can also learn more about <a href="https://landregistry.github.io/bgtechdoc/get_started/how_system_works/#how-our-system-works" class="govuk-link">how the SOAP system works</a>.</p>
103-
<p class="govuk-body">Read our <a href="https://landregistry.github.io/bgtechdoc/rest/get_started/developer_guide/" class="govuk-link">developer guide to REST</a> to integrate using REST/JSON.</p>
102+
<p class="govuk-body">Read our <a href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/get_started/developer_guide" class="govuk-link">developer guide to SOAP</a> to integrate with legacy services using SOAP/XML. You can also learn more about <a href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/get_started/how_system_works/#how-our-system-works" class="govuk-link">how the SOAP system works</a>.</p>
103+
<p class="govuk-body">Read our <a href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/rest/get_started/developer_guide/" class="govuk-link">developer guide to REST</a> to integrate using REST/JSON.</p>
104104
<h3 class="govuk-heading-m">API limitations</h3>
105105
<p class="govuk-body">There are limitations to using REST or SOAP when integrating Business Gateway services.</p>
106106
<h3 class="govuk-heading-m">REST API limitations</h3>
@@ -149,7 +149,7 @@ <h4 class="govuk-body govuk-!-font-weight-bold">Outstanding requests</h4>
149149
<h2 class="govuk-visually-hidden">These links open in a new tab.</h2>
150150
<ul class="govuk-footer__inline-list">
151151
<li class="govuk-footer__inline-list-item">
152-
<a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html">
152+
<a class="govuk-footer__link" href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/accessibility/index.html">
153153
Accessibility Statement
154154
</a>
155155
</li>

‎_site/a-guide-to-testing/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3 class="govuk-heading-m govuk-!-margin-left-3">Testing SOAP and REST APIs</h3
117117
<h2 class="govuk-visually-hidden">These links open in a new tab.</h2>
118118
<ul class="govuk-footer__inline-list">
119119
<li class="govuk-footer__inline-list-item">
120-
<a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html">
120+
<a class="govuk-footer__link" href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/accessibility/index.html">
121121
Accessibility Statement
122122
</a>
123123
</li>

‎_site/apis/application-information/0.3/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ <h2 class="govuk-heading-m govuk-!-margin-0" id="version-and-status">Version and
102102
Version and Status dropdown
103103
</label>
104104
<select class="govuk-select" id="version" name="version">
105-
<option value="1.0">v1.0 (upcoming)</option>
106-
<option value="0.3" selected>v0.3 (latest)</option>
105+
<option value="1.0">v1.0 (latest)</option>
106+
<option value="0.3" selected>v0.3</option>
107107
</select>
108108
<button type="submit"
109109
class="govuk-button govuk-!-margin-0"
@@ -133,7 +133,7 @@ <h2 class="govuk-heading-m" id="view-the-technical-guide" tabindex="-1" class="g
133133
</section>
134134
<section id="view-the-api-specification">
135135
<h2 class="govuk-heading-m" id="view-the-api-specification" tabindex="-1" class="govuk-heading-l">View the API specification</h2>
136-
<p class="govuk-body"><a href="https://landregistry.github.io/bgtechdoc/vcad/v0_3/vcad-spec.html#tag/Application-information-API" rel="noreferrer noopener" target="_blank" class="govuk-link">Web version (opens in new tab)</a></p>
136+
<p class="govuk-body"><a href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/documents/submit-an-application-to-change-the-register/v0.3/openapi.html#tag/Application-information-API" rel="noreferrer noopener" target="_blank" class="govuk-link">Web version (opens in new tab)</a></p>
137137
</section>
138138
<section id="how-the-api-works">
139139
<h2 class="govuk-heading-m" id="how-the-api-works" tabindex="-1" class="govuk-heading-l">How the API works</h2>
@@ -204,7 +204,7 @@ <h2 class="govuk-heading-m" id="related-apis">
204204
<h2 class="govuk-visually-hidden">These links open in a new tab.</h2>
205205
<ul class="govuk-footer__inline-list">
206206
<li class="govuk-footer__inline-list-item">
207-
<a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html">
207+
<a class="govuk-footer__link" href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/accessibility/index.html">
208208
Accessibility Statement
209209
</a>
210210
</li>

‎_site/apis/application-information/0.3/technical-guide/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
navItems.forEach(element => {
3939
let href = element.href.split('#')[1];
4040
let related = document.querySelector("#"+href);
41-
let scrollY = related.offsetTop;
41+
let scrollY = related.offsetTop - 2;
4242
rangeToElement.push({
4343
scroll: scrollY,
4444
element: element
@@ -169,8 +169,8 @@ <h2 class="govuk-heading-m govuk-!-margin-0" id="version-and-status">Version and
169169
Version and Status dropdown
170170
</label>
171171
<select class="govuk-select" id="version" name="version">
172-
<option value="1.0">v1.0 (upcoming)</option>
173-
<option value="0.3" selected>v0.3 (latest)</option>
172+
<option value="1.0">v1.0 (latest)</option>
173+
<option value="0.3" selected>v0.3</option>
174174
</select>
175175
<button type="submit"
176176
class="govuk-button govuk-!-margin-0"
@@ -312,7 +312,7 @@ <h3 class="govuk-heading-m">Related APIs</h3>
312312
<h2 class="govuk-visually-hidden">These links open in a new tab.</h2>
313313
<ul class="govuk-footer__inline-list">
314314
<li class="govuk-footer__inline-list-item">
315-
<a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html">
315+
<a class="govuk-footer__link" href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/accessibility/index.html">
316316
Accessibility Statement
317317
</a>
318318
</li>

‎_site/apis/application-information/0.3/test-stubs/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
navItems.forEach(element => {
3939
let href = element.href.split('#')[1];
4040
let related = document.querySelector("#"+href);
41-
let scrollY = related.offsetTop;
41+
let scrollY = related.offsetTop - 2;
4242
rangeToElement.push({
4343
scroll: scrollY,
4444
element: element
@@ -169,8 +169,8 @@ <h2 class="govuk-heading-m govuk-!-margin-0" id="version-and-status">Version and
169169
Version and Status dropdown
170170
</label>
171171
<select class="govuk-select" id="version" name="version">
172-
<option value="1.0">v1.0 (upcoming)</option>
173-
<option value="0.3" selected>v0.3 (latest)</option>
172+
<option value="1.0">v1.0 (latest)</option>
173+
<option value="0.3" selected>v0.3</option>
174174
</select>
175175
<button type="submit"
176176
class="govuk-button govuk-!-margin-0"
@@ -309,7 +309,7 @@ <h3 class="govuk-heading-m">Related APIs</h3>
309309
<h2 class="govuk-visually-hidden">These links open in a new tab.</h2>
310310
<ul class="govuk-footer__inline-list">
311311
<li class="govuk-footer__inline-list-item">
312-
<a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html">
312+
<a class="govuk-footer__link" href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/accessibility/index.html">
313313
Accessibility Statement
314314
</a>
315315
</li>

‎_site/apis/application-information/1.0/index.html‎

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,6 @@
8181
<h1 class="govuk-heading-xl">Application Information API</h1><p class="govuk-body-l">Use this service to get information about a specific&nbsp;application.</p>
8282
</header>
8383

84-
<div class="govuk-warning-text">
85-
<span class="govuk-warning-text__icon" aria-hidden="true">!</span>
86-
<strong class="govuk-warning-text__text">
87-
<span class="govuk-visually-hidden">Warning</span>
88-
These API endpoints are not currently live.
89-
</strong>
90-
</div>
9184
</div>
9285

9386
<div class="govuk-grid-column-two-thirds">
@@ -102,8 +95,8 @@ <h2 class="govuk-heading-m govuk-!-margin-0" id="version-and-status">Version and
10295
Version and Status dropdown
10396
</label>
10497
<select class="govuk-select" id="version" name="version">
105-
<option value="1.0" selected>v1.0 (upcoming)</option>
106-
<option value="0.3">v0.3 (latest)</option>
98+
<option value="1.0" selected>v1.0 (latest)</option>
99+
<option value="0.3">v0.3</option>
107100
</select>
108101
<button type="submit"
109102
class="govuk-button govuk-!-margin-0"
@@ -135,12 +128,12 @@ <h2 class="govuk-heading-m govuk-!-margin-0" id="version-and-status">Version and
135128
<p class="govuk-body">This API can be used to get more information after receiving a notification indicating the application has changed. For information about which notifications will be available, visit the notifications section of the <a href="/apis/submit-an-application/0.3/technical-guide" class="govuk-link">Submit an application</a> API page.</p>
136129
</section>
137130
<section id="view-the-technical-guide">
138-
<h2 class="govuk-heading-m" id="view-the-technical-guide" tabindex="-1" class="govuk-heading-l">View the Technical guide</h2>
131+
<h2 class="govuk-heading-m" id="view-the-technical-guide" tabindex="-1" class="govuk-heading-l">View the technical guide</h2>
139132
<p class="govuk-body"><a href="./technical-guide" class="govuk-link">Technical guide</a></p>
140133
</section>
141134
<section id="view-the-api-specification">
142135
<h2 class="govuk-heading-m" id="view-the-api-specification" tabindex="-1" class="govuk-heading-l">View the API specification</h2>
143-
<p class="govuk-body"><a href="https://landregistry.github.io/bgtechdoc/vcad/v0_3/vcad-spec.html#tag/Application-information-API" rel="noreferrer noopener" target="_blank" class="govuk-link">Web version (opens in new tab)</a></p>
136+
<p class="govuk-body"><a href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/documents/submit-an-application-to-change-the-register/v1.0/openapi.html#tag/Application-information-API" rel="noreferrer noopener" target="_blank" class="govuk-link">Web version (opens in new tab)</a></p>
144137
</section>
145138
<section id="how-the-api-works">
146139
<h2 class="govuk-heading-m" id="how-the-api-works" tabindex="-1" class="govuk-heading-l">How the API works</h2>
@@ -168,7 +161,7 @@ <h2 class="govuk-heading-m" id="how-to-test-this-api" tabindex="-1" class="govuk
168161
<p class="govuk-body">HMLR has created a test environment for the Application information API. We’ve also provided example code to demonstrate what you should expect when developing your own services.</p>
169162
<ul class="govuk-list">
170163
<li>
171-
<a class="govuk-link" href="./test-stubs">View Application information test stubs.</a>
164+
<a class="govuk-link" href="./test-stubs">View Application information test stubs</a>
172165
</li>
173166
</ul>
174167
<div class="govuk-inset-text">
@@ -189,11 +182,13 @@ <h2 class="govuk-heading-m" id="related-apis">
189182
</h2>
190183
<nav role="navigation" aria-labelledby="related-apis">
191184
<ul class="govuk-list">
192-
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/submit-an-application-to-change-the-land-register">Submit an application to change the Land Register</a></li>
193-
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/send-a-document">Send a document</a></li>
194-
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/submit-an-application">Submit an application</a></li>
195-
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/notifications">Notifications</a></li>
196-
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/download-a-document">Download a document</a></li>
185+
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/submit-an-application-to-change-the-land-register">Submit an application to change the Land Register API</a></li>
186+
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/send-a-document">Send a document API</a></li>
187+
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/submit-an-application">Submit an application API</a></li>
188+
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/attach-a-document">Attach a document API</a></li>
189+
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/attach-a-message">Attach a message API</a></li>
190+
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/notifications">Notifications API</a></li>
191+
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link " href="/apis/download-a-document">Download a document API</a></li>
197192
<li class="govuk-!-margin-bottom-2"><a class="govuk-body govuk-link govuk-!-font-weight-bold" href="/find-a-service-api">More</a></li>
198193
</ul>
199194
</nav>
@@ -211,7 +206,7 @@ <h2 class="govuk-heading-m" id="related-apis">
211206
<h2 class="govuk-visually-hidden">These links open in a new tab.</h2>
212207
<ul class="govuk-footer__inline-list">
213208
<li class="govuk-footer__inline-list-item">
214-
<a class="govuk-footer__link" href="https://landregistry.github.io/bgtechdoc/accessibility/index.html">
209+
<a class="govuk-footer__link" href="https://integration-customer-documentation-bg-int-priv.apps.development.test.stp.hmlr.zone/accessibility/index.html">
215210
Accessibility Statement
216211
</a>
217212
</li>

0 commit comments

Comments
 (0)