Feature/app 47 read corpus type information via admin service

[katybaulch]

Description

Add /all and /get routes for corpus types in the admin service.

Proposed version

Please select the option below that is most relevant from the list below. This
will be used to generate the next tag version name during auto-tagging.

• Skip auto-tagging
• Patch
• Minor version
• Major version

Visit the Semver website to understand the
difference between MAJOR, MINOR, and PATCH versions.

Notes:

• If none of these options are selected, auto-tagging will fail
• Where multiple options are selected, the most senior option ticked will be
  used -- e.g. Major > Minor > Patch
• If you are selecting the version in the list above using the textbox, make
  sure your selected option is marked [x] with no spaces in between the
  brackets and the x

Type of change

Please select the option(s) below that are most relevant:

• Bug fix
• New feature
• Breaking change
• GitHub workflow update
• Documentation update
• Remove legacy code
• Dependency update

How Has This Been Tested?

Please describe the tests that you added to verify your changes.

Reviewer Checklist

• DB_CLIENT DEPENDENCY IS ON THE LATEST VERSION
• The PR represents a single feature (small drive-by fixes are also ok)
• The PR includes tests that are sufficient for the level of risk
• The code is sufficiently commented, particularly in hard-to-understand areas
• Any required documentation updates have been made
• Any TODOs added are captured in future tickets
• No FIXMEs remain

[linear]

APP-47 Read corpus type information via admin service

[jamesgorrie]

Looks good, but I just wonder about using the corpus_type_name as the identifier.

I don't think this API is used outside navigator-admin ecosystem, so it shouldn't expose a breaking change outside of this scope, so maybe not a problem?

[katybaulch]

Looks good, but I just wonder about using the corpus_type_name as the identifier.

I don't think this API is used outside navigator-admin ecosystem, so it shouldn't expose a breaking change outside of this scope, so maybe not a problem?

Corpus types don't have IDs believe it or not 😬 The name is the primary key. We won't be allowing the corpus type name to be changed in the admin service (at least at the moment) - just the corpus type description.

[jamesgorrie]

We won't be allowing the corpus type name to be changed in the admin service

Feels like something we should get to sooner rather than later - minting and IDing our objects. This is probably something that should percolate through the system too.

But that's something that will need a more abstract design, outside the scope of this PR.

[jamesgorrie]

Fab - thanks for the insight from your answers!

[katybaulch]

We won't be allowing the corpus type name to be changed in the admin service

Feels like something we should get to sooner rather than later - minting and IDing our objects. This is probably something that should percolate through the system too.

But that's something that will need a more abstract design, outside the scope of this PR.

Yeah very much agreed!