Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve identifier types #2831

Open
swallez opened this issue Aug 29, 2024 · 0 comments
Open

Improve identifier types #2831

swallez opened this issue Aug 29, 2024 · 0 comments

Comments

@swallez
Copy link
Member

swallez commented Aug 29, 2024

We have a number of types for identifiers (see common.ts) which are used more or less consistently in the API spec.

Currently their role and purpose may not be obvious (what is Id, what is Name?). We should:

  • document these types
  • add a new DocId type for document identifiers. It should replace Id everywhere it is used as document identifier.
  • Id should be kept as a general-purpose string type that distinguishes between unique identifiers in the system (be them internal or external identifiers) and text strings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant