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

Rename test id fields in RPC-API #791

Closed
mattias-p opened this issue Jun 14, 2021 · 1 comment
Closed

Rename test id fields in RPC-API #791

mattias-p opened this issue Jun 14, 2021 · 1 comment
Milestone

Comments

@mattias-p
Copy link
Member

Today there are multiple fields in the API document referring to test ids. These fields are named either "test_id", "id" or "hash_id".

  1. Choose a name to be given to all those fields.
  2. Add replacement parameters with the new name for all those fields that don't already have the chosen name.
  3. For each parameter that's gotten such a replacement, deprecate that parameter with a message encouraging migration to the replacement parameter.
  4. Submitting both the old and new parameters together in the same request should probably be forbidden.

This should not be implemented before #790.

@mattias-p
Copy link
Member Author

Instead of renaming these parameters in existing methods, we're introducing new methods with updated parameter names. Also we're shifting our terminology from "test" to "job". See zonemaster/zonemaster#1175.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants