Add missing attributes to /system/function/{functionName}
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 26.2k
- Forks
- 2k
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behaviour
Attributes used to create a function with the POST endpoint should be mirrored when retrieving the function meta data using the GET endpoint
Current Behaviour
The attributes are currently as follows:
| Name | POST | GET |
|---|---|---|
| service |
|
|
| network |
|
|
| image |
|
|
| envProcess |
|
|
| envVars |
|
|
| constraints |
|
|
| labels |
|
|
| annotations |
|
|
| secrets |
|
|
| registryAuth |
|
|
| limits |
|
|
| requests |
|
|
| readOnlyRootFilesystem |
|
|
Possible Solution
swagger.ymladd missing attributes toFunctionListEntrygateway/requests/requests.goadd missing attributes toFunctiontypefaas-swarm/handlers/reader.goadd missing attributes inreadServicesfuncfaas-netesadd missing attributesfaas-operatoradd missing attributesfaas-clidescribeverb when merged may need updating
Context
I'm writing a terraform provider for openfaas, to work well with terraform, it's best if the underlying infrastructure apis have mirrored POST/GET endpoints. This is also a very common practice in REST apis
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 with swagger.yml's FunctionListEntry and gateway/requests/requests.go's Function type, then trace readServices in faas-swarm/handlers/reader.go. Check the corresponding faas-netes and faas-operator implementations and the faas-cli describe verb. Done means the GET function metadata mirrors the POST attributes, with the sensitive registryAuth decision resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, openapi
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100