From bf3a0332f3022a1f297668f89a398b4e2664197a Mon Sep 17 00:00:00 2001 From: Christopher Blanchard Date: Fri, 8 Mar 2024 13:04:07 +0000 Subject: [PATCH] Reorganise --- docs/docs/methods/postcode-validation.mdx | 12 ---- .../lookup.mdx} | 4 +- .../nearest.mdx} | 4 +- .../reverse-geocode.mdx} | 4 +- .../outcode.mdx => outcode/schema.mdx} | 4 +- .../place-lookup.mdx => place/lookup.mdx} | 4 +- .../place-query.mdx => place/query.mdx} | 4 +- .../random-place.mdx => place/random.mdx} | 4 +- .../places.mdx => place/schema.mdx} | 4 +- .../autocomplete.mdx} | 4 +- .../bulk-reverse-geocode.mdx} | 4 +- .../bulk.mdx} | 6 +- .../lookup.mdx} | 4 +- .../nearest.mdx} | 4 +- .../postcode-query.mdx => postcode/query.mdx} | 4 +- .../random.mdx} | 4 +- .../reverse-geocode.mdx} | 4 +- .../postcode.mdx => postcode/schema.mdx} | 4 +- .../lookup.mdx} | 4 +- .../schema.mdx} | 4 +- .../lookup.mdx} | 4 +- .../schema.mdx} | 4 +- docs/sidebars.ts | 67 ++++++++++++------- 23 files changed, 86 insertions(+), 79 deletions(-) delete mode 100644 docs/docs/methods/postcode-validation.mdx rename docs/docs/{methods/outward-code-lookup.mdx => outcode/lookup.mdx} (79%) rename docs/docs/{methods/nearest-outcode.mdx => outcode/nearest.mdx} (86%) rename docs/docs/{methods/outcode-reverse-geocoding.mdx => outcode/reverse-geocode.mdx} (84%) rename docs/docs/{data-fields/outcode.mdx => outcode/schema.mdx} (97%) rename docs/docs/{methods/place-lookup.mdx => place/lookup.mdx} (79%) rename docs/docs/{methods/place-query.mdx => place/query.mdx} (87%) rename docs/docs/{methods/random-place.mdx => place/random.mdx} (67%) rename docs/docs/{data-fields/places.mdx => place/schema.mdx} (98%) rename docs/docs/{methods/postcode-autocomplete.mdx => postcode/autocomplete.mdx} (80%) rename docs/docs/{methods/bulk-reverse-geocoding.mdx => postcode/bulk-reverse-geocode.mdx} (95%) rename docs/docs/{methods/bulk-postcode-lookup.mdx => postcode/bulk.mdx} (85%) rename docs/docs/{methods/postcode-lookup.mdx => postcode/lookup.mdx} (81%) rename docs/docs/{methods/nearest-postcode.mdx => postcode/nearest.mdx} (89%) rename docs/docs/{methods/postcode-query.mdx => postcode/query.mdx} (93%) rename docs/docs/{methods/random-postcode.mdx => postcode/random.mdx} (81%) rename docs/docs/{methods/reverse-geocoding.mdx => postcode/reverse-geocode.mdx} (93%) rename docs/docs/{data-fields/postcode.mdx => postcode/schema.mdx} (99%) rename docs/docs/{methods/scottish-postcode-lookup.mdx => scottish-postcode/lookup.mdx} (84%) rename docs/docs/{data-fields/scottish.mdx => scottish-postcode/schema.mdx} (92%) rename docs/docs/{methods/terminated-postcode-lookup.mdx => terminated-postcode/lookup.mdx} (76%) rename docs/docs/{data-fields/terminated.mdx => terminated-postcode/schema.mdx} (94%) diff --git a/docs/docs/methods/postcode-validation.mdx b/docs/docs/methods/postcode-validation.mdx deleted file mode 100644 index a3aaac3b..00000000 --- a/docs/docs/methods/postcode-validation.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_label: "Postcode Lookup" -title: "Postcode Lookup" ---- - -Convenience method to validate a postcode. Returns true or false (meaning valid or invalid respectively) - -```javascript -GET https://api.postcodes.io/postcodes/:postcode/validate -``` - -View our guide on [postcode validation](https://ideal-postcodes.co.uk/guides/postcode-validation) to see a more detailed explanation diff --git a/docs/docs/methods/outward-code-lookup.mdx b/docs/docs/outcode/lookup.mdx similarity index 79% rename from docs/docs/methods/outward-code-lookup.mdx rename to docs/docs/outcode/lookup.mdx index 82d512eb..ce7f255a 100644 --- a/docs/docs/methods/outward-code-lookup.mdx +++ b/docs/docs/outcode/lookup.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Outcode Lookup" -title: "Outcode Lookup" +sidebar_label: "Lookup" +title: "Lookup an Outward Code" --- Geolocation data for the centroid of the outward code specified. The outward code represents the first half of any postcode (separated by a space). diff --git a/docs/docs/methods/nearest-outcode.mdx b/docs/docs/outcode/nearest.mdx similarity index 86% rename from docs/docs/methods/nearest-outcode.mdx rename to docs/docs/outcode/nearest.mdx index ec1ea3d6..aab385f7 100644 --- a/docs/docs/methods/nearest-outcode.mdx +++ b/docs/docs/outcode/nearest.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Nearest Outcode" -title: "Nearest Outcode" +sidebar_label: "Nearest" +title: "Retrieve Nearest Outward Code" --- Returns nearest outcodes for a given outcode. diff --git a/docs/docs/methods/outcode-reverse-geocoding.mdx b/docs/docs/outcode/reverse-geocode.mdx similarity index 84% rename from docs/docs/methods/outcode-reverse-geocoding.mdx rename to docs/docs/outcode/reverse-geocode.mdx index 429b7ea6..04b1004c 100644 --- a/docs/docs/methods/outcode-reverse-geocoding.mdx +++ b/docs/docs/outcode/reverse-geocode.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Outcode Reverse Geocoding" -title: "Outcode Reverse Geocoding" +sidebar_label: "Reverse Geocode" +title: "Reverse Geocode an Outcode" --- Returns nearest outcodes for a given longitude and latitude. diff --git a/docs/docs/data-fields/outcode.mdx b/docs/docs/outcode/schema.mdx similarity index 97% rename from docs/docs/data-fields/outcode.mdx rename to docs/docs/outcode/schema.mdx index 9f2b33d8..36cfb606 100644 --- a/docs/docs/data-fields/outcode.mdx +++ b/docs/docs/outcode/schema.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Outcode Data" -title: "Outcode Data (Ordnance Survey Postcode Directory Dataset)" +sidebar_label: "Schema" +title: "Outward Code Schema" --- Data Returned by the `/outcodes` API diff --git a/docs/docs/methods/place-lookup.mdx b/docs/docs/place/lookup.mdx similarity index 79% rename from docs/docs/methods/place-lookup.mdx rename to docs/docs/place/lookup.mdx index ab5bbe88..c43c9b87 100644 --- a/docs/docs/methods/place-lookup.mdx +++ b/docs/docs/place/lookup.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Place Lookup" -title: "Place Lookup" +sidebar_label: "Lookup" +title: "Lookup a GB Place" --- Find a place by OSGB code (e.g. "osgb4000000074564391"). Returns all available data if found. Returns 404 if place does not exist. diff --git a/docs/docs/methods/place-query.mdx b/docs/docs/place/query.mdx similarity index 87% rename from docs/docs/methods/place-query.mdx rename to docs/docs/place/query.mdx index 227e2997..b617c9ec 100644 --- a/docs/docs/methods/place-query.mdx +++ b/docs/docs/place/query.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Place Query" -title: "Place Query" +sidebar_label: "Query" +title: "Query for GB place" --- Submit a place query and receive a complete list of places matches and associated data. diff --git a/docs/docs/methods/random-place.mdx b/docs/docs/place/random.mdx similarity index 67% rename from docs/docs/methods/random-place.mdx rename to docs/docs/place/random.mdx index 7a04138d..30cacb33 100644 --- a/docs/docs/methods/random-place.mdx +++ b/docs/docs/place/random.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Random Place" -title: "Random Place" +sidebar_label: "Random" +title: "Retrieve a Random Place" --- Returns a random place and all associated data diff --git a/docs/docs/data-fields/places.mdx b/docs/docs/place/schema.mdx similarity index 98% rename from docs/docs/data-fields/places.mdx rename to docs/docs/place/schema.mdx index 88dbb238..b8448774 100644 --- a/docs/docs/data-fields/places.mdx +++ b/docs/docs/place/schema.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Places Data" -title: "Places Data (Ordnance Survey Open Names Dataset)" +sidebar_label: "Schema" +title: "Places Schema" --- Data Returned by the `/places` API diff --git a/docs/docs/methods/postcode-autocomplete.mdx b/docs/docs/postcode/autocomplete.mdx similarity index 80% rename from docs/docs/methods/postcode-autocomplete.mdx rename to docs/docs/postcode/autocomplete.mdx index 093fedc0..6beca33e 100644 --- a/docs/docs/methods/postcode-autocomplete.mdx +++ b/docs/docs/postcode/autocomplete.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Postcode Autocomplete" -title: "Postcode Autocomplete" +sidebar_label: "Autocomplete" +title: "Autocomplete a Postcode" --- Convenient method to return an list of matching postcodes. diff --git a/docs/docs/methods/bulk-reverse-geocoding.mdx b/docs/docs/postcode/bulk-reverse-geocode.mdx similarity index 95% rename from docs/docs/methods/bulk-reverse-geocoding.mdx rename to docs/docs/postcode/bulk-reverse-geocode.mdx index 2427375d..1123442b 100644 --- a/docs/docs/methods/bulk-reverse-geocoding.mdx +++ b/docs/docs/postcode/bulk-reverse-geocode.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Bulk Reverse Geocoding" -title: "Bulk Reverse Geocoding" +sidebar_label: "Bulk Reverse Geocode" +title: "Bulk Reverse Geocode Postcodes" --- Bulk translates geolocations into Postcodes. Accepts up to 100 geolocations. diff --git a/docs/docs/methods/bulk-postcode-lookup.mdx b/docs/docs/postcode/bulk.mdx similarity index 85% rename from docs/docs/methods/bulk-postcode-lookup.mdx rename to docs/docs/postcode/bulk.mdx index 56e7de1e..6c98beb8 100644 --- a/docs/docs/methods/bulk-postcode-lookup.mdx +++ b/docs/docs/postcode/bulk.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Bulk Postcode Lookup" -title: "Bulk Postcode Lookup" +sidebar_label: "Bulk Lookup" +title: "Bulk Lookup Postcodes" --- Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data. @@ -19,7 +19,7 @@ This method requires a JSON object containing an array of postcodes to be posted ```JSON { - "postcodes" : ["PR3 0SG", "M45 6GN", "EX165BL"] + "postcodes" : ["PR3 0SG", "M45 6GN", "EX165BL"] } ``` diff --git a/docs/docs/methods/postcode-lookup.mdx b/docs/docs/postcode/lookup.mdx similarity index 81% rename from docs/docs/methods/postcode-lookup.mdx rename to docs/docs/postcode/lookup.mdx index fb143ad1..2060d4a4 100644 --- a/docs/docs/methods/postcode-lookup.mdx +++ b/docs/docs/postcode/lookup.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Postcode Lookup" -title: "Postcode Lookup" +sidebar_label: "Lookup" +title: "Lookup a Postcode" --- This uniquely identifies a postcode. diff --git a/docs/docs/methods/nearest-postcode.mdx b/docs/docs/postcode/nearest.mdx similarity index 89% rename from docs/docs/methods/nearest-postcode.mdx rename to docs/docs/postcode/nearest.mdx index 19df4a42..6d74045a 100644 --- a/docs/docs/methods/nearest-postcode.mdx +++ b/docs/docs/postcode/nearest.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Nearest Postcode" -title: "Nearest Postcode" +sidebar_label: "Nearest" +title: "Find Nearest Postcode" --- Returns nearest postcodes for a given postcode. diff --git a/docs/docs/methods/postcode-query.mdx b/docs/docs/postcode/query.mdx similarity index 93% rename from docs/docs/methods/postcode-query.mdx rename to docs/docs/postcode/query.mdx index abd7bc46..dd07eecd 100644 --- a/docs/docs/methods/postcode-query.mdx +++ b/docs/docs/postcode/query.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Postcode Query" -title: "Postcode Query" +sidebar_label: "Query" +title: "Query for a Postcode" --- Submit a postcode query and receive a complete list of postcode matches and all associated postcode data. diff --git a/docs/docs/methods/random-postcode.mdx b/docs/docs/postcode/random.mdx similarity index 81% rename from docs/docs/methods/random-postcode.mdx rename to docs/docs/postcode/random.mdx index 14c31cb6..4363396c 100644 --- a/docs/docs/methods/random-postcode.mdx +++ b/docs/docs/postcode/random.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Random Postcode" -title: "Random Postcode" +sidebar_label: "Random" +title: "Retrieve a Random Postcode" --- Returns a random postcode and all available data for that postcode. diff --git a/docs/docs/methods/reverse-geocoding.mdx b/docs/docs/postcode/reverse-geocode.mdx similarity index 93% rename from docs/docs/methods/reverse-geocoding.mdx rename to docs/docs/postcode/reverse-geocode.mdx index 6a909ef2..540aa651 100644 --- a/docs/docs/methods/reverse-geocoding.mdx +++ b/docs/docs/postcode/reverse-geocode.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Reverse Geocoding" -title: "Reverse Geocoding" +sidebar_label: "Reverse Geocode" +title: "Reverse Geocode a Postcode" --- Returns nearest postcodes for a given longitude and latitude. diff --git a/docs/docs/data-fields/postcode.mdx b/docs/docs/postcode/schema.mdx similarity index 99% rename from docs/docs/data-fields/postcode.mdx rename to docs/docs/postcode/schema.mdx index 0d731e51..ecebe055 100644 --- a/docs/docs/data-fields/postcode.mdx +++ b/docs/docs/postcode/schema.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Postcode Data" -title: "Postcode Data (Ordnance Survey Postcode Directory Dataset)" +sidebar_label: "Schema" +title: "Postcode Model" --- Data Points Returned by the `/postcodes` and `/outcodes` API diff --git a/docs/docs/methods/scottish-postcode-lookup.mdx b/docs/docs/scottish-postcode/lookup.mdx similarity index 84% rename from docs/docs/methods/scottish-postcode-lookup.mdx rename to docs/docs/scottish-postcode/lookup.mdx index a523f50b..5bdfce16 100644 --- a/docs/docs/methods/scottish-postcode-lookup.mdx +++ b/docs/docs/scottish-postcode/lookup.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Scottish Postcode Lookup" -title: "Scottish Postcode Lookup" +sidebar_label: "Lookup" +title: "Lookup a Scottish Postcode" --- Lookup a Scottish postcode. Returns SPD data associated with postcode. At the moment this is just Scottish Parliamentary Constituency. diff --git a/docs/docs/data-fields/scottish.mdx b/docs/docs/scottish-postcode/schema.mdx similarity index 92% rename from docs/docs/data-fields/scottish.mdx rename to docs/docs/scottish-postcode/schema.mdx index a9bd76cd..7be56db4 100644 --- a/docs/docs/data-fields/scottish.mdx +++ b/docs/docs/scottish-postcode/schema.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Scottish Postcode Data" -title: "Scottish Postcode Data (Scottish Postcode Directory)" +sidebar_label: "Schema" +title: "Scottish Postcode Schema" --- Data Returned by the `/scotland/*` APIs diff --git a/docs/docs/methods/terminated-postcode-lookup.mdx b/docs/docs/terminated-postcode/lookup.mdx similarity index 76% rename from docs/docs/methods/terminated-postcode-lookup.mdx rename to docs/docs/terminated-postcode/lookup.mdx index adea0b4c..45f0692d 100644 --- a/docs/docs/methods/terminated-postcode-lookup.mdx +++ b/docs/docs/terminated-postcode/lookup.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Terminated Postcode Lookup" -title: "Terminated Postcode Lookup" +sidebar_label: "Lookup" +title: "Lookup a Terminated Postcode" --- Lookup a terminated postcode. Returns the postcode, year and month of termination. Returns 404 if postcode does not exist in our database of terminated postcodes or not valid. diff --git a/docs/docs/data-fields/terminated.mdx b/docs/docs/terminated-postcode/schema.mdx similarity index 94% rename from docs/docs/data-fields/terminated.mdx rename to docs/docs/terminated-postcode/schema.mdx index b53588f9..7230b51c 100644 --- a/docs/docs/data-fields/terminated.mdx +++ b/docs/docs/terminated-postcode/schema.mdx @@ -1,6 +1,6 @@ --- -sidebar_label: "Terminated Postcode Data" -title: "Terminated Postcode Data (Ordnance Survey Postcode Directory Dataset)" +sidebar_label: "Schema" +title: "Terminated Postcode Schema" --- Data Returned by the `/terminated_postcodes/*` APIs diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 1507b154..d90891e4 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -21,38 +21,57 @@ const sidebars: SidebarsConfig = { "self-host", { type: "category", - label: "Available Data Fields", + label: "Postcodes", collapsed: false, items: [ - "data-fields/postcode", - "data-fields/outcode", - "data-fields/scottish", - "data-fields/terminated", - "data-fields/places", + "postcode/schema", + "postcode/lookup", + "postcode/query", + "postcode/bulk", + "postcode/random", + "postcode/autocomplete", + "postcode/reverse-geocode", + "postcode/bulk-reverse-geocode", ], }, { type: "category", - label: "Methods", + label: "Outward Codes", collapsed: false, items: [ - "methods/postcode-lookup", - "methods/bulk-postcode-lookup", - "methods/reverse-geocoding", - "methods/bulk-reverse-geocoding", - "methods/postcode-query", - "methods/postcode-validation", - "methods/nearest-postcode", - "methods/postcode-autocomplete", - "methods/random-postcode", - "methods/outward-code-lookup", - "methods/outcode-reverse-geocoding", - "methods/nearest-outcode", - "methods/scottish-postcode-lookup", - "methods/terminated-postcode-lookup", - "methods/place-lookup", - "methods/place-query", - "methods/random-place", + "outcode/schema", + "outcode/lookup", + "outcode/reverse-geocode", + "outcode/nearest", + ], + }, + { + type: "category", + label: "Places", + collapsed: false, + items: [ + "place/schema", + "place/lookup", + "place/query", + "place/random", + ], + }, + { + type: "category", + label: "Terminated Postcodes", + collapsed: false, + items: [ + "terminated-postcode/schema", + "terminated-postcode/lookup", + ], + }, + { + type: "category", + label: "Scottish Postcodes", + collapsed: false, + items: [ + "scottish-postcode/schema", + "scottish-postcode/lookup", ], }, ],