Comments (7)
OK I found I can use 'Header' to map the APIKey payload, but it seems that it should not have been necessary.
from goa.
Some APIs use query string parameters for API keys so Goa can't assume it is a header.
from goa.
OK, but if I don't specify anything, it does automatically use a header. However the check in SkipRequestBodyEncodeDecode does not consider it was mapped in this case.
from goa.
Ah sorry I had missed the point about the default behavior. That is indeed inconsistent - reopening :)
from goa.
I tried to reproduce this issue but wasn't able to, the following works as expected:
package design
import . "goa.design/goa/v3/dsl"
// APIKeyAuth defines a security scheme that uses API keys.
var APIKeyAuth = APIKeySecurity("api_key", func() {
Description("Secures endpoint by requiring an API key.")
})
var _ = Service("foo", func() {
Method("bar", func() {
Security(APIKeyAuth)
Payload(func() {
APIKey("api_key", "key")
})
HTTP(func() {
POST("/")
SkipRequestBodyEncodeDecode()
})
})
})
If you are still seeing the issue can you please provide a design that reproduces it?
from goa.
Hi, it took me a bit of time to understand, to reproduce the issue, the Security
statement must be made at the Service
level, not Method
package design
import . "goa.design/goa/v3/dsl"
// APIKeyAuth defines a security scheme that uses API keys.
var APIKeyAuth = APIKeySecurity("api_key", func() {
Description("Secures endpoint by requiring an API key.")
})
var _ = Service("foo", func() {
Security(APIKeyAuth)
Method("bar", func() {
Payload(func() {
APIKey("api_key", "key")
})
HTTP(func() {
POST("/")
SkipRequestBodyEncodeDecode()
})
})
})
from goa.
Thanks for the repro! This is fixed by #3359
from goa.
Related Issues (20)
- can't set cookie 'SameSite' attribute HOT 2
- How to get the native *http.Request from the payload? HOT 2
- Missing schemas in OpenAPI spec when using union types HOT 3
- Declare POST request contain an array of object HOT 2
- Bumping goa.design/plugins/v3 from 3.14.0 to 3.14.1 is causing my client generation to fail HOT 3
- Generated code for nested inline attributes doesn't compile HOT 2
- Deprecated Code in Generated http.go using goa example
- meta for externalDocs and deprecated? HOT 4
- Map as Query Param not working? HOT 2
- Using Param() to map path parameters to attributes results in a runtime error HOT 5
- Panic in main HOT 2
- Goa panics when query params have unclosed square brackets HOT 2
- Goa panics when a user provides an explicit `null` where a `Map` is expected, if it's a nested structure HOT 2
- Middleware in design? HOT 6
- Goa generating uncompilable code while using views on types that contain OneOf union type
- Goa generating invalid code when OneOf types is a user defined type
- Example generation failed in the latest version HOT 3
- Generated server code parses query parameters repeatedly HOT 1
- Getting the Raw Query? HOT 1
- Allow implementing `io.WriterTo` for `SkipResponseBodyEncodeDecode` responses. HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from goa.