Add tests for /api/v1/locations/{language} endpoint by ZeterTheDuck · Pull Request #98 · JustServe-Resources/devkit

ZeterTheDuck · 2026-05-18T17:48:46Z

This also adds the needed schema for generated classes in the schema.yml file.

Fixes 602200d

This makes tests directly reference the endpoint they are testing, to resolve any ambiguity.

Jonathan-Zollinger

really great work! a few changes, but this would have been a great PR without these changes as well - great work!

Jonathan-Zollinger · 2026-05-18T19:39:15Z

    - Image
    - User
    - Organization
    - Project


Suggested change

- Project

- Location

- Locale

Jonathan-Zollinger · 2026-05-18T19:48:13Z

+    CountryStatePair:
+      type: object
+      properties:
+        countryInfo:
+          $ref: "#/components/schemas/CountryInfo"
+        country:
+          type: string
+          nullable: true
+        state:
+          type: string
+          nullable: true
+        county:
+          type: string
+          nullable: true


Let's take this opportunity to improve on this name since it's not really a 'pair'. I'm interested to hear your suggestions, but maybe something along the lines of "CountryContext" as it's more accurate to its name?

Jonathan-Zollinger · 2026-05-18T19:52:29Z

+    CountryInfo:
+      type: object
+      properties:
+        twoCharCode:
+          type: string
+          nullable: true
+        threeCharCode:
+          type: string
+          nullable: true
+        countryPhone:
+          type: string
+          nullable: true
+      additionalProperties: false


another opportunity to have this make more sense than what we originally inherited - let's go with 'CountryIdentifiers'. When I first read "country info", I was thinking I'd see data about the country at a high level, but it's specifically identifiers and nothing more.

Jonathan-Zollinger · 2026-05-18T19:53:29Z

+      type: object
+      properties:
+        twoCharCode:
+          type: string


Suggested change

type: string

type: string

description: "ISO 3166-1 standard two letter country code"

Jonathan-Zollinger · 2026-05-18T19:54:58Z

+          type: string
+          nullable: true
+        threeCharCode:
+          type: string


Suggested change

type: string

type: string

description: "ISO 3166-1 standard three letter country code"

Jonathan-Zollinger · 2026-05-18T20:15:17Z

+    get:
+      tags: [ Location ]
+      description: Get all locations in a language
+      operationId: getLanguage


Suggested change

operationId: getLanguage

operationId: getLocation

Jonathan-Zollinger · 2026-05-18T20:16:26Z

+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/CountryStatePair"


see my comments on 2044

Jonathan-Zollinger · 2026-05-18T20:19:17Z

            application/json:
              schema:
                $ref: '#/components/schemas/ImageUploadResponse'
+  /api/v1/locations/{language}:


Let's also add the GET Languages endpoint for our tests

Suggested change

/api/v1/locations/{language}:

/api/v1/languages:

get:

tags:

- Language

responses:

"200":

description: OK

content:

text/plain:

schema:

type: array

items:

$ref: "#/components/schemas/LocaleNames"

application/json:

schema:

type: array

items:

$ref: "#/components/schemas/LocaleNames"

text/json:

schema:

type: array

items:

$ref: "#/components/schemas/LocaleNames"

/api/v1/locations/{language}:

Jonathan-Zollinger · 2026-05-18T20:31:10Z

+          nullable: true
+        county:
+          type: string
+          nullable: true


Suggested change

nullable: true

nullable: true

LocaleNames:

type: object

properties:

bcp47:

description: locale abbreviation per the <a href='https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag' BCP 47 standard</a>

type: string

nullable: true

name:

description: locale name

type: string

nullable: true

for the name field, can you see if it returns the three char code that would map to the field on line 2024 or if it's a human-readable field? if it's meant to be the three char field, let's document it as such.

Navigating to stage.justserve.org, it appears that the name is a human-readable field. I'll also add the "lang3char" field that you missed.

check what the response is in stage - the swagger docs I'm using may be outdated but they only reference the two fields I've added above.

Also, I'm not sure if these are going to be usable, because the lang3char field does not seem to follow any standardized format. For instance, French is "fre", which matches the older legacy code for ISO 639, but Portuguese is "prt", which isn't at all used in ISO 639, but used in ISO 3166 for Portugal. However, "fre" is not present in ISO 3166. So there would have to be some more in-depth restructuring to use these.

You can see what's available by going to /api/languages

let's remove the iso description from them then, but still add some helpful docs (just without the iso reference). I wish we knew the rhyme or reason for the different strings

Jonathan-Zollinger · 2026-05-18T20:31:47Z

+    def "result data from .../locations/{language} matches expected format"() {
+        given:
+        def lang = "eng"
+
+        when:
+        def location = locationClient.getLanguage(lang).block().first
+
+        then:
+        verifyAll {
+            location != null
+            location.getCountryInfo() != null
+
+            location.getCountryInfo().getTwoCharCode() == null || location.getCountryInfo().getTwoCharCode() ==~ /[a-z]{2}/
+            location.getCountryInfo().getThreeCharCode() == null || location.getCountryInfo().getThreeCharCode() ==~ /[a-z]{3}/
+            location.getCountryInfo().getCountryPhone() == null || location.getCountryInfo().getCountryPhone() ==~ /\d+/
+            location.getCountry() == null || location.getCountry() ==~ /.+/
+            location.getState() == null || location.getState() ==~ /.+/
+            location.getCounty() == null || location.getCounty() ==~ /.+/
+        }
+    }
+}


follow the same edits as the test above.

ZeterTheDuck added 6 commits May 15, 2026 13:55

test(core): add test for valid data types for a given language

602200d

fix: validate that locations can be serialized

dbb9104

Fixes 602200d

refactor: clean up locationSpec

e294c50

test: add comprehensive tests for /locations/{language} endpoint

57e7879

fix: correct api endpoint call

e2c89cb

style: clarify test messages

61054a8

This makes tests directly reference the endpoint they are testing, to resolve any ambiguity.

Jonathan-Zollinger self-requested a review May 18, 2026 19:37

Jonathan-Zollinger requested changes May 18, 2026

View reviewed changes

ZeterTheDuck and others added 6 commits May 18, 2026 16:03

test: applied suggestions from PR #98

71c800d

fix: correct lang3Chain type definition

d526361

test: add missing LanguageSpec

ad00d9c

refactor(test): test all locales, remove repeated test

700262c

refactor: add method name & correct tags summary.

5b35ca3

style: add missing whitespace

93f01d0

Jonathan-Zollinger merged commit 04c1efb into main May 19, 2026
1 check failed

Jonathan-Zollinger deleted the madsen/support-locations branch May 19, 2026 03:54

ZeterTheDuck mentioned this pull request Jun 5, 2026

Add support for Locations Operations #107

Open

13 tasks

	type: string
	type: string
	description: "ISO 3166-1 standard two letter country code"

	type: string
	type: string
	description: "ISO 3166-1 standard three letter country code"

-  /api/v1/locations/{language}:
+  /api/v1/languages:
+    get:
+      tags:
+        - Language
+      responses:
+        "200":
+          description: OK
+          content:
+            text/plain:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/LocaleNames"
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/LocaleNames"
+            text/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/LocaleNames"
+  /api/v1/locations/{language}:

Conversation

ZeterTheDuck commented May 18, 2026

Uh oh!

Jonathan-Zollinger left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jonathan-Zollinger May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Jonathan-Zollinger May 18, 2026 •

edited

Loading