Requirements for Managment APIs
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 45
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
As disccussed in today's security call with @mmccool. We need to identify a set of requirements for APIs that handles runtime configuration and security initialization (i.e., fill secrets). Prescribing those requirements can help to make assumptions in the description of the Scripting API. For example in the newly added ExposedThingInit algorithm we could refer to the presence of a set of securityDefinitions configured with such API.
I think this addition could help also implementers to know how to handle out-of-band security data and protocol binding configurations.
Related work (kindof): https://github.com/w3c/wot-scripting-api/tree/master/applications/script-manager
Related:
https://github.com/w3c/wot-scripting-api/pull/289#issuecomment-775182073
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked applications/script-manager work and the discussion in pull request 289. Then inspect the newly added ExposedThingInit algorithm and its securityDefinitions reference. Done means a reviewed, explicit set of requirements for management APIs covering runtime configuration, security initialization, out-of-band security data, and protocol binding configurations.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, backend-api-design, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100