Review Sourcify APIv2 proposed design and identify impact

[SimiHunjan]

Problem

We are designing our next APIv2 and looking for feedback from people using Sourcify. We'd appreciate if you can have a look at the current design and docs shortly, and let us know what you think.
The current draft design and docs can be found at: https://sourcify.stoplight.io/docs/sourcify-apiv2/branches/main/
Some major differences:

• We no longer respond the verification request on the /verify endpoint. Instead we return a verification-job-id that can be polled for the job status.
• Our main verification endpoint will be the std-JSON but we'll still support metadata.json based verification
• We have a really detailed GET /contract/{chainId}/{address} endpoint. By default it returns minimal info but one can ask for specific fields e.g. ?fields=abi,metadata,storageLayout,creationBytecode.sourceMap,deployment.blockNumber or everything *. This is thanks to now us saving everything in a nicely formatted DB
  Tracker issues for details:
• [Milestone] Finish APIv2 design ethereum/sourcify#1470
• Draft APIv2 request and responses ethereum/sourcify#1545

In particular, they're adopting a ticketing system for their main API
Ticketing: The verfication requests resolve into tickets/verification jobs.
Previously the verification happened during the HTTP request, which resulted in timeouts if compilation took longer

Solution

Review the proposed design, offer feedback, and identify impact to the project.

Alternatives

No response

[acuarica]

I asked if the verification preview feature is going to be supported in the new Sourcify v2 design here ethereum/sourcify#1545 (comment).